NAME
CL_TargaProvider - Surface provider that can load targa (.tga) files.
CLASS MEMBERS
- static CL_Surface *create(
-
std::string handle, CL_InputSourceProvider *provider, bool transparent=false, bool ignore_alphachannel=false, unsigned char trans_red=0, unsigned char trans_green=0, unsigned char trans_blue=0)
- virtual int get_translate_x()
- virtual int get_translate_y()
- virtual unsigned int get_width()
- virtual unsigned int get_height()
- virtual unsigned int get_num_frames()
- virtual unsigned int get_depth()
- 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 bool is_indexed()
- virtual CL_Palette *get_palette()
- 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(
-
std::string handle, CL_InputSourceProvider *provider, bool transparent=false, bool ignore_alphachannel=false, unsigned char trans_red=0, unsigned char trans_green=0, unsigned char trans_blue=0)
Description:
Loads the targa file handle from the inputsource provider provider. Creates a CL_Surface using the targa image and returns it.If you just want to load a file, use handle' for filename, and set provider to NULLReturns the pitch of the image (bytes per line).
- virtual int get_translate_x()
-
Description:
Returns how many pixels to translate the image (X axis).
- virtual int get_translate_y()
-
Description:
Returns how many pixels to translate the image (Y axis).
- 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_depth()
-
Description:
Returns the pixelformat 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 bool is_indexed()
-
Description:
- virtual CL_Palette *get_palette()
-
Description:
Returns the palette used by the image. NULL if system palette.
- virtual bool uses_src_colorkey()
-
Description:
- virtual unsigned int get_src_colorkey()
-
Description:
Returns the transparency color used, -1 if none.
- 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.
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.