---

CL_SpriteProvider Class Reference

clanDisplay="Surface Providers". More...

#include <sprite.h>

Inheritance diagram for CL_SpriteProvider:

[legend]Collaboration diagram for CL_SpriteProvider:

[legend]List of all members.

Public Methods
	CL_SpriteProvider (const char *surface_id, CL_InputSourceProvider *datafile)
virtual	~CL_SpriteProvider ()
virtual unsigned int	get_width () const
virtual unsigned int	get_height () const
virtual unsigned int	get_pitch () const
virtual unsigned int	get_num_frames () const
	retval: A pointer that points to the beginning of the target pixel data.
virtual CL_Palette*	get_palette () const
virtual bool	uses_src_colorkey () const
	retval: The y-offset of the surface data.
virtual unsigned int	get_src_colorkey () 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 unsigned int	get_depth () const
virtual bool	is_indexed () const
virtual void*	get_data () const
virtual void	perform_lock ()
virtual void	perform_unlock ()
Static Public Methods
CL_Surface*	create (const char *surface_id, CL_InputSourceProvider *datafile)
Protected Methods
void	load_data ()
Protected Attributes
std::string	surface_id
CL_InputSourceProvider*	provider
void*	surface_data
int	width
int	height
int	no_sprs
int	transcol
CL_Palette*	palette
unsigned int	red_mask
unsigned int	green_mask
unsigned int	blue_mask
unsigned int	alpha_mask
unsigned int	bpp
bool	m_is_indexed

---

Detailed Description

clanDisplay="Surface Providers".

Definition at line 32 of file sprite.h.

---

Constructor & Destructor Documentation

CL_SpriteProvider::CL_SpriteProvider ( const char * surface_id, CL_InputSourceProvider * datafile )

virtual CL_SpriteProvider::~CL_SpriteProvider ( ) [virtual]

---

Member Function Documentation

CL_Surface* CL_SpriteProvider::create ( const char * surface_id, CL_InputSourceProvider * datafile ) [static]

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

virtual unsigned int CL_SpriteProvider::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_SpriteProvider::get_palette ( ) const [virtual]

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_SurfaceProvider.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

void CL_SpriteProvider::load_data ( ) [protected]

virtual void CL_SpriteProvider::perform_lock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

virtual void CL_SpriteProvider::perform_unlock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

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

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

---

Member Data Documentation

unsigned int CL_SpriteProvider::alpha_mask [protected]

Definition at line 42 of file sprite.h.

unsigned int CL_SpriteProvider::blue_mask [protected]

Definition at line 42 of file sprite.h.

unsigned int CL_SpriteProvider::bpp [protected]

Definition at line 43 of file sprite.h.

unsigned int CL_SpriteProvider::green_mask [protected]

Definition at line 42 of file sprite.h.

int CL_SpriteProvider::height [protected]

Definition at line 40 of file sprite.h.

bool CL_SpriteProvider::m_is_indexed [protected]

Definition at line 44 of file sprite.h.

int CL_SpriteProvider::no_sprs [protected]

Definition at line 40 of file sprite.h.

CL_Palette* CL_SpriteProvider::palette [protected]

Definition at line 41 of file sprite.h.

CL_InputSourceProvider* CL_SpriteProvider::provider [protected]

Definition at line 38 of file sprite.h.

unsigned int CL_SpriteProvider::red_mask [protected]

Definition at line 42 of file sprite.h.

void* CL_SpriteProvider::surface_data [protected]

Definition at line 39 of file sprite.h.

std::string CL_SpriteProvider::surface_id [protected]

Definition at line 37 of file sprite.h.

int CL_SpriteProvider::transcol [protected]

Definition at line 40 of file sprite.h.

int CL_SpriteProvider::width [protected]

Definition at line 40 of file sprite.h.

---

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

• sprite.h

---