NAME
CL_MPEGProvider - A surface provider that can show MPEG animations.
CLASS MEMBERS
- static CL_Surface *create(
-
char *filename)
- static CL_Surface *create(
-
char *filename, int dithermode)
- CL_MPEGProvider(
-
const char *filename, int dithermode)
- virtual ~CL_MPEGProvider()
- virtual void rewind()
- virtual unsigned int get_framerate()
- virtual unsigned int get_width()
- virtual unsigned int get_height()
- virtual unsigned int get_pitch()
- virtual unsigned int get_num_frames()
- virtual EPixelFormat get_pixel_format()
- 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 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 *filename)
Parameters: filename - The mpeg file to use.
Description:
Creates a surface using the mpeg file filename as source.
- static CL_Surface *create(
-
char *filename, int dithermode)
Description:
Creates a surface using the mpeg filename as source and dithermode passed to libmpeg.
- CL_MPEGProvider(
-
const char *filename, int dithermode)
Parameters: filename - mpeg file to use. dithermode - passed to libmpeg.
Description:
Constructs a surfaceprovider using the mpeg file filename as source, passing flags to libmpeg.
- virtual ~CL_MPEGProvider()
-
Description:
- virtual void rewind()
-
Description:
Rewinds the mpeg stream
- virtual unsigned int get_framerate()
-
Description:
Returns the framerate
- 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_pitch()
-
Description:
Returns the pitch of the Image.
- virtual unsigned int get_num_frames()
-
Description:
Returns the number of subsprites in the image.
- virtual EPixelFormat get_pixel_format()
-
Description:
Returns the pixel format used by the image.
- virtual unsigned int get_red_mask()
-
Description:
- virtual unsigned int get_green_mask()
-
Description:
- virtual unsigned int get_blue_mask()
-
Description:
- virtual unsigned int get_alpha_mask()
-
Description:
- virtual CL_Palette *get_palette()
-
Description:
Returns the palette used by the image. NULL if system palette.
- virtual bool is_indexed()
-
Description:
- virtual bool uses_src_colorkey()
-
Description:
- virtual unsigned int get_src_colorkey()
-
Description:
Returns the transparency color used the image. -1 if none.
- 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.