Reference

CL_PNGProvider(3)

Surface provider that can load PNG (.png) files.

NAME

CL_PNGProvider - Surface provider that can load PNG (.png) files.

CLASS MEMBERS

CL_InputSource* get_input_source()
virtual unsigned int get_width()
virtual unsigned int get_height()
virtual unsigned int get_num_frames()
virtual EPixelFormat get_pixel_format()
virtual CL_Palette *get_palette()
virtual unsigned int get_src_colorkey()
virtual bool uses_src_colorkey()
virtual bool is_indexed()
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 void *get_data()
virtual void perform_lock()
virtual void perform_unlock()

MEMBERS WITH DESCRIPTIONS

CL_InputSource* get_input_source()
Description:

returns Pointer to CL_InputSource(used by libpng-callback CL_PNGProviderReturns the pitch of the image (bytes per line).

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 EPixelFormat get_pixel_format()
Description:

Returns the pixelformat used by the image.

virtual CL_Palette *get_palette()
Description:

Returns the palette used by the image. NULL if system palette.

virtual unsigned int get_src_colorkey()
Description:

Returns the transparency color used.

virtual bool uses_src_colorkey()
Description:

Returns whether a source colorkey is used.

virtual bool is_indexed()
Description:

Returns whether the target uses an indexed color mode or not.

virtual unsigned int get_red_mask()
Description:

Returns the red color mask used by the target.

virtual unsigned int get_green_mask()
Description:

Returns the green color mask by the target.

virtual unsigned int get_blue_mask()
Description:

Returns the blue color mask by the target.

virtual unsigned int get_alpha_mask()
Description:

Returns the alpha mask by the target.

virtual void *get_data()
Description:

Returns the image data. Provider must be locked before pointer is valid.

virtual void perform_lock()
Description:

Locks the surface provider.

virtual void perform_unlock()
Description:

Unlocks the surface provider.Callback used by libpng to retrieve the filedata. (calls get_input_source()->read_uchar8())

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.