# wxAnimation Class Reference
[Graphics Device Interface (GDI)]

`#include </home/work/projects/wx/2.9/wx/interface/wx/animate.h>`

Inheritance diagram for wxAnimation:
[legend]

## Detailed Description

This class encapsulates the concept of a platform-dependent animation.

An animation is a sequence of frames of the same size. Sound is not supported by wxAnimation.

Note that on wxGTK wxAnimation is capable of loading the formats supported by the internally-used `gdk-pixbuf` library (typically this means only `wxANIMATION_TYPE_GIF`). On other platforms wxAnimation is always capable of loading both GIF and ANI formats (i.e. both `wxANIMATION_TYPE_GIF` and `wxANIMATION_TYPE_ANI`).

##

Library: wxAdvanced
Category: Graphics Device Interface (GDI)

Predefined objects/pointers: wxNullAnimation

See also:
  wxAnimationCtrl, Animation Sample

## Public Member Functions

| wxAnimation (const wxAnimation &anim)
| Copy ctor.
| wxAnimation (const wxString &name, wxAnimationType type=wxANIMATION_TYPE_ANY)
| Loads an animation from a file.
virtual | ~wxAnimation ()
| Destructor.
virtual int | GetDelay (unsigned int i) const
| Returns the delay for the i-th frame in milliseconds.
virtual wxImage | GetFrame (unsigned int i) const
| Returns the i-th frame as a wxImage.
virtual unsigned int | GetFrameCount () const
| Returns the number of frames for this animation.
virtual wxSize | GetSize () const
| Returns the size of the animation.
virtual bool | IsOk () const
| Returns true if animation data is present.
virtual bool | Load (wxInputStream &stream, wxAnimationType type=wxANIMATION_TYPE_ANY)
| Loads an animation from the given stream.
virtual bool | LoadFile (const wxString &name, wxAnimationType type=wxANIMATION_TYPE_ANY)
| Loads an animation from a file.
wxAnimation & | operator= (const wxAnimation &brush)
| Assignment operator, using reference counting.

List of all members.

## Constructor & Destructor Documentation

wxAnimation::wxAnimation | ( | const wxAnimation & | anim | ) |

Copy ctor.

wxAnimation::wxAnimation | ( | const wxString & | name,
|  | wxAnimationType | type = `wxANIMATION_TYPE_ANY` |
| ) |  |  |

Loads an animation from a file.

Parameters:

  | name | The name of the file to load.
  | type | See LoadFile() for more info.

virtual wxAnimation::~wxAnimation | ( |  | ) | `[virtual]`

Destructor.

See Object Destruction for more info.

## Member Function Documentation

virtual int wxAnimation::GetDelay | ( | unsigned int | i | ) | const`[virtual]`

Returns the delay for the i-th frame in milliseconds.

If `-1` is returned the frame is to be displayed forever.

virtual wxImage wxAnimation::GetFrame | ( | unsigned int | i | ) | const`[virtual]`

Returns the i-th frame as a wxImage.

virtual unsigned int wxAnimation::GetFrameCount | ( |  | ) | const`[virtual]`

Returns the number of frames for this animation.

virtual wxSize wxAnimation::GetSize | ( |  | ) | const`[virtual]`

Returns the size of the animation.

virtual bool wxAnimation::IsOk | ( |  | ) | const`[virtual]`

Returns true if animation data is present.

virtual bool wxAnimation::Load | ( | wxInputStream & | stream,
|  | wxAnimationType | type = `wxANIMATION_TYPE_ANY` |
| ) |  |  | `[virtual]`

Loads an animation from the given stream.

Parameters:

  | stream | The stream to use to load the animation. Under wxGTK may be any kind of stream; under other platforms this must be a seekable stream.
  | type | One of the wxAnimationType enumeration values.

Returns:
  true if the operation succeeded, false otherwise.

virtual bool wxAnimation::LoadFile | ( | const wxString & | name,
|  | wxAnimationType | type = `wxANIMATION_TYPE_ANY` |
| ) |  |  | `[virtual]`

Loads an animation from a file.

Parameters:

  | name | A filename.
  | type | One of the wxAnimationType values; wxANIMATION_TYPE_ANY means that the function should try to autodetect the filetype.

Returns:
  true if the operation succeeded, false otherwise.

wxAnimation& wxAnimation::operator= | ( | const wxAnimation & | brush | ) |

Assignment operator, using reference counting.

|  | [ top ]