---

CL_SpriteSubarrayProvider Class Reference

clanDisplay="Surface Providers". More...

#include <sprite_subarray_provider.h>

Inheritance diagram for CL_SpriteSubarrayProvider:

[legend]Collaboration diagram for CL_SpriteSubarrayProvider:

[legend]List of all members.

Public Methods
	CL_SpriteSubarrayProvider (CL_SurfaceProvider *parent_provider, int start_x, int start_y, int width, int height, int array_width, int array_height)
virtual	~CL_SpriteSubarrayProvider ()
virtual unsigned int	get_pitch () const
virtual int	get_translate_x () const
virtual int	get_translate_y () const
	retval: The x-offset of the surface data.
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 CL_Palette*	get_palette () const
virtual bool	uses_src_colorkey () const
	retval: The y-offset of the surface data.
virtual bool	is_indexed () const
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 void*	get_data () const
virtual void	perform_lock ()
virtual void	perform_unlock ()
Static Public Methods
CL_Surface*	create (CL_SurfaceProvider *parent_provider, int start_x, int start_y, int width, int height, int array_width, int array_height)
Private Attributes
CL_SurfaceProvider*	parent_provider
bool	locked
int	start_x
int	start_y
int	width
int	height
int	array_width
int	array_height
unsigned char*	surface_data

---

Detailed Description

clanDisplay="Surface Providers".

Definition at line 26 of file sprite_subarray_provider.h.

---

Constructor & Destructor Documentation

CL_SpriteSubarrayProvider::CL_SpriteSubarrayProvider ( CL_SurfaceProvider * parent_provider, int start_x, int start_y, int width, int height, int array_width, int array_height )

virtual CL_SpriteSubarrayProvider::~CL_SpriteSubarrayProvider ( ) [virtual]

---

Member Function Documentation

CL_Surface* CL_SpriteSubarrayProvider::create ( CL_SurfaceProvider * parent_provider, int start_x, int start_y, int width, int height, int array_width, int array_height ) [static]

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_SurfaceProvider.

virtual int CL_SpriteSubarrayProvider::get_translate_x ( ) const [virtual]

Reimplemented from CL_SurfaceProvider.

virtual int CL_SpriteSubarrayProvider::get_translate_y ( ) const [virtual]

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

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

virtual void CL_SpriteSubarrayProvider::perform_lock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

virtual void CL_SpriteSubarrayProvider::perform_unlock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

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

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

---

Member Data Documentation

int CL_SpriteSubarrayProvider::array_height [private]

Definition at line 32 of file sprite_subarray_provider.h.

int CL_SpriteSubarrayProvider::array_width [private]

Definition at line 32 of file sprite_subarray_provider.h.

int CL_SpriteSubarrayProvider::height [private]

Definition at line 31 of file sprite_subarray_provider.h.

bool CL_SpriteSubarrayProvider::locked [private]

Definition at line 29 of file sprite_subarray_provider.h.

CL_SurfaceProvider* CL_SpriteSubarrayProvider::parent_provider [private]

Definition at line 28 of file sprite_subarray_provider.h.

int CL_SpriteSubarrayProvider::start_x [private]

Definition at line 30 of file sprite_subarray_provider.h.

int CL_SpriteSubarrayProvider::start_y [private]

Definition at line 30 of file sprite_subarray_provider.h.

unsigned char* CL_SpriteSubarrayProvider::surface_data [private]

Definition at line 33 of file sprite_subarray_provider.h.

int CL_SpriteSubarrayProvider::width [private]

Definition at line 31 of file sprite_subarray_provider.h.

---

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

• sprite_subarray_provider.h

---