All Classes |Grouped Classes |Index

Class CL_SpriteDescription

This class contains everything to construct a sprite - its data, default settings etc. More...

Derived from:

None

Derived by:

None

Group:

2D (Display)

#include <ClanLib/display.h>

Class Members:

Construction:

CL_SpriteDescription

Constructs a sprite description.


Attributes:

get_frames

Returns a list over all available frames.


Operations:

add_frame

Adds a single image.

add_frames

Add frames.

add_gridclipped_frames

Adds images formed in a grid.

add_alphaclipped_frames

Adds images separated with pure alpha (within trans_limit).

add_alphaclipped_frames_free

Adds images separated with pure alpha (within trans_limit).

set_frame_delay

Sets the duration this frame is displayed, in seconds.

Detailed description:

CL_SpriteDescription is used by CL_Sprite to construct itself based on the description. The description class give a big flexibility creating a sprite, individual frames can come from different image sources, or be cut out from an image source using various different techniques.