---

CL_BMPProvider Class Reference

#include <provider_bmp.h>

Inheritance diagram for CL_BMPProvider:

[legend]Collaboration diagram for CL_BMPProvider:

[legend]List of all members.

Public Methods
	CL_BMPProvider (std::string name, CL_InputSourceProvider *provider, bool transparent=false, short trans_col=-1)
virtual	~CL_BMPProvider ()
	param: name - Name of the bmp file to load.param: provider - Input source provider that delivers the bmp file.param: transparent - True if a color in image should be transparent.param: trans_col - Transparency color used if 'transparent' is true. Defaults to color 0.
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 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 unsigned int	get_depth () const
virtual CL_Palette*	get_palette () const
virtual bool	is_indexed () const
virtual bool	uses_src_colorkey () const
	retval: The y-offset of the surface data.
virtual unsigned int	get_src_colorkey () const
virtual void*	get_data () const
virtual void	perform_lock ()
virtual void	perform_unlock ()
Static Public Methods
CL_Surface*	create (std::string handle, CL_InputSourceProvider *provider, bool transparent=false, short trans_col=-1)
Private Attributes
CL_InputSourceProvider*	provider
bool	transparent
int	trans_col
std::string	name
char	magic [2]
unsigned int	bfSize
unsigned short	bfReserved1
unsigned short	bfReserved2
unsigned int	bfOffBits
unsigned int	biSize
int	biWidth
int	biHeight
unsigned short	biPlanes
unsigned short	biBitCount
unsigned int	biCompression
unsigned int	biSizeImage
int	biXPelsPerMeter
int	biYPelsPerMeter
unsigned int	biClrUsed
unsigned int	biClrImportant
CL_Palette*	palette
unsigned char*	image

---

Constructor & Destructor Documentation

CL_BMPProvider::CL_BMPProvider ( std::string name, CL_InputSourceProvider * provider, bool transparent = false, short trans_col = -1 )

CL_BMPProvider::~CL_BMPProvider ( ) [virtual]

param: name - Name of the bmp file to load.param: provider - Input source provider that delivers the bmp file.param: transparent - True if a color in image should be transparent.param: trans_col - Transparency color used if 'transparent' is true. Defaults to color 0.

---

Member Function Documentation

CL_Surface* CL_BMPProvider::create ( std::string handle, CL_InputSourceProvider * provider, bool transparent = false, short trans_col = -1 ) [static]

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

void * CL_BMPProvider::get_data ( ) const [inline, virtual]

Reimplemented from CL_Target. Definition at line 106 of file provider_bmp.h.

virtual unsigned int CL_BMPProvider::get_depth ( ) const [virtual]

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

unsigned int CL_BMPProvider::get_height ( ) const [inline, virtual]

Reimplemented from CL_Target. Definition at line 81 of file provider_bmp.h.

unsigned int CL_BMPProvider::get_num_frames ( ) const [inline, virtual]

retval: A pointer that points to the beginning of the target pixel data. Reimplemented from CL_Target. Definition at line 84 of file provider_bmp.h.

CL_Palette * CL_BMPProvider::get_palette ( ) const [inline, virtual]

Reimplemented from CL_Target. Definition at line 96 of file provider_bmp.h.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

unsigned int CL_BMPProvider::get_src_colorkey ( ) const [inline, virtual]

Reimplemented from CL_SurfaceProvider. Definition at line 103 of file provider_bmp.h.

unsigned int CL_BMPProvider::get_width ( ) const [inline, virtual]

Reimplemented from CL_Target. Definition at line 78 of file provider_bmp.h.

bool CL_BMPProvider::is_indexed ( ) const [inline, virtual]

Reimplemented from CL_Target. Definition at line 99 of file provider_bmp.h.

virtual void CL_BMPProvider::perform_lock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

virtual void CL_BMPProvider::perform_unlock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

bool CL_BMPProvider::uses_src_colorkey ( ) const [inline, virtual]

retval: The y-offset of the surface data. Reimplemented from CL_SurfaceProvider. Definition at line 101 of file provider_bmp.h.

---

Member Data Documentation

unsigned int CL_BMPProvider::bfOffBits [private]

Definition at line 133 of file provider_bmp.h.

unsigned short CL_BMPProvider::bfReserved1 [private]

Definition at line 131 of file provider_bmp.h.

unsigned short CL_BMPProvider::bfReserved2 [private]

Definition at line 132 of file provider_bmp.h.

unsigned int CL_BMPProvider::bfSize [private]

Definition at line 130 of file provider_bmp.h.

unsigned short CL_BMPProvider::biBitCount [private]

Definition at line 140 of file provider_bmp.h.

unsigned int CL_BMPProvider::biClrImportant [private]

Definition at line 146 of file provider_bmp.h.

unsigned int CL_BMPProvider::biClrUsed [private]

Definition at line 145 of file provider_bmp.h.

unsigned int CL_BMPProvider::biCompression [private]

Definition at line 141 of file provider_bmp.h.

int CL_BMPProvider::biHeight [private]

Definition at line 138 of file provider_bmp.h.

unsigned short CL_BMPProvider::biPlanes [private]

Definition at line 139 of file provider_bmp.h.

unsigned int CL_BMPProvider::biSize [private]

Definition at line 136 of file provider_bmp.h.

unsigned int CL_BMPProvider::biSizeImage [private]

Definition at line 142 of file provider_bmp.h.

int CL_BMPProvider::biWidth [private]

Definition at line 137 of file provider_bmp.h.

int CL_BMPProvider::biXPelsPerMeter [private]

Definition at line 143 of file provider_bmp.h.

int CL_BMPProvider::biYPelsPerMeter [private]

Definition at line 144 of file provider_bmp.h.

unsigned char* CL_BMPProvider::image [private]

Definition at line 150 of file provider_bmp.h.

char CL_BMPProvider::magic[2] [private]

Definition at line 129 of file provider_bmp.h.

std::string CL_BMPProvider::name [private]

Definition at line 121 of file provider_bmp.h.

CL_Palette* CL_BMPProvider::palette [private]

Definition at line 149 of file provider_bmp.h.

CL_InputSourceProvider* CL_BMPProvider::provider [private]

Definition at line 116 of file provider_bmp.h.

int CL_BMPProvider::trans_col [private]

Definition at line 120 of file provider_bmp.h.

bool CL_BMPProvider::transparent [private]

Definition at line 119 of file provider_bmp.h.

---

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

• provider_bmp.h

---