NAME
CL_FLIProvider - A surface provider that can show FLi/FLc animations.
CLASS MEMBERS
- static CL_Surface *create(
-
char *fliname)
- static CL_Surface *create(
-
char *fliname, int frameno)
- CL_FLIProvider(
-
const char *fli_file, int start_frame)
- virtual ~CL_FLIProvider()
- virtual unsigned int get_width()
- virtual unsigned int get_height()
- virtual unsigned int get_num_frames()
- virtual unsigned int get_red_mask()
- virtual unsigned int get_green_mask()
- virtual unsigned int get_blue_mask()
- virtual unsigned int get_alpha_mask()
- virtual CL_Palette *get_palette()
- virtual unsigned int get_pitch()
- virtual unsigned int get_depth()
- virtual bool is_indexed()
- virtual bool uses_src_colorkey()
- virtual unsigned int get_src_colorkey()
- virtual void *get_data()
- virtual void perform_lock()
- virtual void perform_unlock()
MEMBERS WITH DESCRIPTIONS
- static CL_Surface *create(
-
char *fliname)
Parameters: fliname - The .flc / .fli file to use.
Description:
Creates a surface using the FLi/FLc file fliname as source.
- static CL_Surface *create(
-
char *fliname, int frameno)
Description:
Creates a surface using the FLi/FLc file filename as source and frameno as start frame.
- CL_FLIProvider(
-
const char *fli_file, int start_frame)
Parameters: fli_file - .flc / .fli file to use. start_frame - Initial frame to be delivered by the surface provider.
Description:
Constructs a surfaceprovider using the FLi/FLc file fli_file as source, starting at frame start_frame.
- virtual ~CL_FLIProvider()
-
Description:
- virtual unsigned int get_width()
-
Description:
Returns the width of the image.
- virtual unsigned int get_height()
-
Description:
Returns the height of the image.
- virtual unsigned int get_num_frames()
-
Description:
Returns the number of subsprites in the image.
- virtual unsigned int get_red_mask()
-
Description:
Returns the red color mask.
- virtual unsigned int get_green_mask()
-
Description:
Returns the green color mask.
- virtual unsigned int get_blue_mask()
-
Description:
Returns the blue color mask.
- virtual unsigned int get_alpha_mask()
-
Description:
Returns the alpha color mask.
- virtual CL_Palette *get_palette()
-
Description:
Returns the palette used by the image. NULL if system palette.
- virtual unsigned int get_pitch()
-
Description:
- virtual unsigned int get_depth()
-
Description:
- virtual bool is_indexed()
-
Description:
- virtual bool uses_src_colorkey()
-
Description:
Returns true if provider uses a source color key.
- virtual unsigned int get_src_colorkey()
-
Description:
Returns the transparency color used the image.
- virtual void *get_data()
-
Description:
Returns a pointer to the image data. Must be locked before data is valid.
- virtual void perform_lock()
-
Description:
Locks the surface provider.
- virtual void perform_unlock()
-
Description:
Unlocks the surface provider.
SEE ALSO
All ClanLib API classes can be found in clanlib (3).
AUTHORS
Originally written by Magnus Norddahl <[email protected]> and Martin Starch <[email protected]>. ClanLib is now developed by the ClanLib Development team as an Open Source project.
The ClanLib man pages was created using the Perceps documentation system (another excellent piece of Open Source software, available at http://somewhere.in.the.world.org).
See clanlib (3) to find out how to get a full list of contributors and details on how to submit bug reports, comments etc.