---

CL_JPEGProvider Class Reference

#include <provider_jpeg.h>

Inheritance diagram for CL_JPEGProvider:

[legend]Collaboration diagram for CL_JPEGProvider:

[legend]List of all members.

Public Methods
	CL_JPEGProvider (CL_String name, CL_InputSourceProvider *provider=NULL, bool transparent=true, bool ignore_alphachannel=false)
virtual	~CL_JPEGProvider ()
	param: name - Name of the PNG file to load.param: provider - Input source provider that delivers the JPEG file.param: transparent - True if a transparency color should be used.param: ignore_alphachannel - True if the alpha component should be ignored.param: trans_red - Red component of the transparency color.param: trans_green - Green component of the transparency color.param: trans_blue - blue component of the transparency color.
virtual unsigned int	get_pitch () const
virtual unsigned int	get_width () const
virtual unsigned int	get_height () const
virtual unsigned int	get_num_frames () const
	retval: A pointer that points to the beginning of the target pixel data.
virtual EPixelFormat	get_pixel_format () const
virtual CL_Palette*	get_palette () const
virtual unsigned int	get_src_colorkey () const
virtual bool	uses_src_colorkey () const
	retval: The y-offset of the surface data.
virtual bool	is_indexed () const
virtual unsigned int	get_red_mask () const
virtual unsigned int	get_green_mask () const
virtual unsigned int	get_blue_mask () const
virtual unsigned int	get_alpha_mask () const
virtual void*	get_data () const
virtual void	lock ()
	retval: True if stored in video memory, false otherwise.
virtual void	unlock ()
Static Public Methods
CL_Surface*	create (const CL_String &handle, CL_InputSourceProvider *provider=NULL, bool transparent=true, bool ignore_alphachannel=false)
Private Attributes
class CL_JPEGProvider_Generic*	impl

---

Constructor & Destructor Documentation

CL_JPEGProvider::CL_JPEGProvider ( CL_String name, CL_InputSourceProvider * provider = NULL, bool transparent = true, bool ignore_alphachannel = false )

CL_JPEGProvider::~CL_JPEGProvider ( ) [virtual]

param: name - Name of the PNG file to load.param: provider - Input source provider that delivers the JPEG file.param: transparent - True if a transparency color should be used.param: ignore_alphachannel - True if the alpha component should be ignored.param: trans_red - Red component of the transparency color.param: trans_green - Green component of the transparency color.param: trans_blue - blue component of the transparency color.

---

Member Function Documentation

CL_Surface* CL_JPEGProvider::create ( const CL_String & handle, CL_InputSourceProvider * provider = NULL, bool transparent = true, bool ignore_alphachannel = false ) [static]

virtual unsigned int CL_JPEGProvider::get_alpha_mask ( ) const [virtual]

Reimplemented from CL_Target.

virtual unsigned int CL_JPEGProvider::get_blue_mask ( ) const [virtual]

Reimplemented from CL_Target.

virtual void* CL_JPEGProvider::get_data ( ) const [virtual]

Reimplemented from CL_Target.

virtual unsigned int CL_JPEGProvider::get_green_mask ( ) const [virtual]

Reimplemented from CL_Target.

virtual unsigned int CL_JPEGProvider::get_height ( ) const [virtual]

Reimplemented from CL_Target.

virtual unsigned int CL_JPEGProvider::get_num_frames ( ) const [virtual]

retval: A pointer that points to the beginning of the target pixel data. Reimplemented from CL_Target.

virtual CL_Palette* CL_JPEGProvider::get_palette ( ) const [virtual]

Reimplemented from CL_Target.

virtual unsigned int CL_JPEGProvider::get_pitch ( ) const [virtual]

Reimplemented from CL_Target.

virtual EPixelFormat CL_JPEGProvider::get_pixel_format ( ) const [virtual]

virtual unsigned int CL_JPEGProvider::get_red_mask ( ) const [virtual]

Reimplemented from CL_Target.

virtual unsigned int CL_JPEGProvider::get_src_colorkey ( ) const [virtual]

Reimplemented from CL_SurfaceProvider.

virtual unsigned int CL_JPEGProvider::get_width ( ) const [virtual]

Reimplemented from CL_Target.

virtual bool CL_JPEGProvider::is_indexed ( ) const [virtual]

Reimplemented from CL_Target.

virtual void CL_JPEGProvider::lock ( ) [virtual]

retval: True if stored in video memory, false otherwise. Reimplemented from CL_Target.

virtual void CL_JPEGProvider::unlock ( ) [virtual]

Reimplemented from CL_Target.

virtual bool CL_JPEGProvider::uses_src_colorkey ( ) const [virtual]

retval: The y-offset of the surface data. Reimplemented from CL_SurfaceProvider.

---

Member Data Documentation

class CL_JPEGProvider_Generic* CL_JPEGProvider::impl [private]

Definition at line 106 of file provider_jpeg.h.

---

The documentation for this class was generated from the following file:

• provider_jpeg.h

---