ANIMATION control and animation GIF (GIF87a/GIF89a) support

Modules
	Styles of ANIMATION control
	Messages of ANIMATION control
	Notification code of ANIMATION control

Data Structures
struct	_ANIMATIONFRAME
struct	_ANIMATION

Macros
#define	CTRL_ANIMATION   ("Animation")
#define	ANIMATION_OKAY   0
#define	ANIMATION_ERR   1

Typedefs
typedef struct _ANIMATIONFRAME	ANIMATIONFRAME
typedef struct _ANIMATION	ANIMATION

Functions
ANIMATION *	CreateAnimationFromGIF89a (HDC hdc, MG_RWops *area)
	Creates an ANIMATION obeject from a GIF 89a data source. More...
MG_EXPORT ANIMATION *	CreateAnimationFromGIF89aFile (HDC hdc, const char *file)
	Creates an ANIMATION obeject from a GIF 89a file. More...
MG_EXPORT ANIMATION *	CreateAnimationFromGIF89aMem (HDC hdc, const void *mem, int size)
	Creates an ANIMATION obeject from a GIF 89a memory data. More...
MG_EXPORT void	DestroyAnimation (ANIMATION *anim, BOOL free_it)
	Destories an ANIMATION object. More...

Detailed Description

Macro Definition Documentation

ANIMATION_ERR

#define ANIMATION_ERR   1

Return values of ANIMATION control.

Definition at line 206 of file animation.h.

ANIMATION_OKAY

#define ANIMATION_OKAY   0

Return values of ANIMATION control.

Definition at line 204 of file animation.h.

CTRL_ANIMATION

#define CTRL_ANIMATION   ("Animation")

Control class name of ANIMATION control.

Definition at line 201 of file animation.h.

Typedef Documentation

ANIMATION

typedef struct _ANIMATION ANIMATION

Animation structure

ANIMATIONFRAME

typedef struct _ANIMATIONFRAME ANIMATIONFRAME

Animation frame structure.

Function Documentation

CreateAnimationFromGIF89a()

ANIMATION * CreateAnimationFromGIF89a	(	HDC	hdc,
		MG_RWops *	area
	)

Creates an ANIMATION obeject from a GIF 89a data source.

This function load a GIF 89a graphic from the data source area, and create an ANIMATION object from the GIF 89a data.

Parameters

hdc	The dc will be used to create BITMAP object for the animation frame.
area	The data source.

Returns

This function returns an ANIMATION object when success, otherwise NULL.

See also

DestroyAnimation, ANIMATION

CreateAnimationFromGIF89aFile()

ANIMATION * CreateAnimationFromGIF89aFile	(	HDC	hdc,
		const char *	file
	)

Creates an ANIMATION obeject from a GIF 89a file.

This function load a GIF 89a graphic from the file file, and create an ANIMATION object.

Parameters

hdc	The dc will be used to create BITMAP object for the animation frame.
file	The file name.

Returns

This function returns an ANIMATION object when success, otherwise NULL.

See also

DestroyAnimation, ANIMATION

CreateAnimationFromGIF89aMem()

ANIMATION * CreateAnimationFromGIF89aMem	(	HDC	hdc,
		const void *	mem,
		int	size
	)

Creates an ANIMATION obeject from a GIF 89a memory data.

This function load a GIF 89a graphic from the memory mem which is size long and create an ANIMATION object from the GIF 89a data.

Parameters

hdc	The dc will be used to create BITMAP object for the animation frame.
mem	The pointer to the memory.
size	The size of the memory.

Returns

This function returns an ANIMATION object when success, otherwise NULL.

See also

DestroyAnimation, ANIMATION

DestroyAnimation()

void DestroyAnimation	(	ANIMATION *	anim,
		BOOL	free_it
	)

Destories an ANIMATION object.

This function destroies the ANIMATION object anim, and free it if free_it is TRUE.

Parameters

anim	Pointer to the ANIMATION object.
free_it	Specify whether free the object by calling free(3).

See also

CreateAnimationFromGIF89a, ANIMATION