iAnimatedImage Struct Reference (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
iAnimatedImage Struct Reference
2D

If an image file has animation capabilities, then this interface is exhibited. More...

`#include <igraphic/animimg.h>`

Inheritance diagram for iAnimatedImage:

List of all members.

## Public Member Functions
virtual bool | Animate (csTicks time, csRect *dirtyrect=0)=0
| Update the image data.
virtual bool | IsAnimated ()=0
| Return whether or not this image is really animated, ie if the animation has more than one frame or not.

## Detailed Description

If an image file has animation capabilities, then this interface is exhibited.

Definition at line 39 of file animimg.h.

## Member Function Documentation

virtual bool iAnimatedImage::Animate | ( | csTicks | time,
|  | csRect * | dirtyrect = `0`
| ) |  | `[pure virtual]`

Update the image data.

Parameters:

  time | Time that passed since the last call to Animate().
  dirtyrect | If not 0, the area that has changed is filled in.

Returns:
  Whether any image data has changed at all.

virtual bool iAnimatedImage::IsAnimated | ( |  | ) | `[pure virtual]`

Return whether or not this image is really animated, ie if the animation has more than one frame or not.

Returns:
  false if the animation has just 1 frame, true otherwise.

The documentation for this struct was generated from the following file:

- igraphic/animimg.h