---

CL_Sprite2Provider Class Reference

clanDisplay="Surface Providers". More...

#include <sprite2.h>

Inheritance diagram for CL_Sprite2Provider:

[legend]Collaboration diagram for CL_Sprite2Provider:

[legend]List of all members.

Public Methods
	CL_Sprite2Provider (CL_InputSource *source)
	CL_Sprite2Provider (CL_SurfaceProvider *src, int x, int y, int width, int height, int *tcols, int tcols_num)
virtual	~CL_Sprite2Provider ()
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 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 unsigned int	get_depth () const
virtual void*	get_data () const
virtual void	perform_lock ()
virtual void	perform_unlock ()
Protected Methods
void	load_data (CL_InputSource *datafile)
Protected Attributes
std::string	surface_id
void*	surface_data
int	width
int	height
int	no_sprs
int	transcol
CL_Palette*	palette
EPixelFormat	pixelformat
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 30 of file sprite2.h.

---

Constructor & Destructor Documentation

CL_Sprite2Provider::CL_Sprite2Provider ( CL_InputSource * source )

CL_Sprite2Provider::CL_Sprite2Provider ( CL_SurfaceProvider * src, int x, int y, int width, int height, int * tcols, int tcols_num )

virtual CL_Sprite2Provider::~CL_Sprite2Provider ( ) [virtual]

---

Member Function Documentation

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_SurfaceProvider.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

void CL_Sprite2Provider::load_data ( CL_InputSource * datafile ) [protected]

virtual void CL_Sprite2Provider::perform_lock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

virtual void CL_Sprite2Provider::perform_unlock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

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

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

---

Member Data Documentation

unsigned int CL_Sprite2Provider::alpha_mask [protected]

Definition at line 38 of file sprite2.h.

unsigned int CL_Sprite2Provider::blue_mask [protected]

Definition at line 38 of file sprite2.h.

unsigned int CL_Sprite2Provider::bpp [protected]

Definition at line 39 of file sprite2.h.

unsigned int CL_Sprite2Provider::green_mask [protected]

Definition at line 38 of file sprite2.h.

int CL_Sprite2Provider::height [protected]

Definition at line 35 of file sprite2.h.

bool CL_Sprite2Provider::m_is_indexed [protected]

Definition at line 40 of file sprite2.h.

int CL_Sprite2Provider::no_sprs [protected]

Definition at line 35 of file sprite2.h.

CL_Palette* CL_Sprite2Provider::palette [protected]

Definition at line 36 of file sprite2.h.

EPixelFormat CL_Sprite2Provider::pixelformat [protected]

Definition at line 37 of file sprite2.h.

unsigned int CL_Sprite2Provider::red_mask [protected]

Definition at line 38 of file sprite2.h.

void* CL_Sprite2Provider::surface_data [protected]

Definition at line 34 of file sprite2.h.

std::string CL_Sprite2Provider::surface_id [protected]

Definition at line 33 of file sprite2.h.

int CL_Sprite2Provider::transcol [protected]

Definition at line 35 of file sprite2.h.

int CL_Sprite2Provider::width [protected]

Definition at line 35 of file sprite2.h.

---

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

• sprite2.h

---