---

CL_PCXProvider Class Reference

clanDisplay="Surface Providers". More...

#include <provider_pcx.h>

Inheritance diagram for CL_PCXProvider:

[legend]Collaboration diagram for CL_PCXProvider:

[legend]List of all members.

Public Methods
	CL_PCXProvider (std::string name, CL_InputSourceProvider *provider, bool transparent=false, unsigned char trans_col=0)
virtual	~CL_PCXProvider ()
	param: name - Name of the pcx file to load.param: provider - Input source provider that delivers the pcx 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 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 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 ()
virtual void	read_header (CL_InputSource *_datafile)
virtual void	read_data ()
Static Public Methods
CL_Surface*	create (std::string handle, CL_InputSourceProvider *provider, bool transparent=false, unsigned char trans_col=0)
Private Attributes
int	num_planes
int	dest_num_planes
int	size_data
unsigned char	pcx_version
unsigned char	bits_per_pixel_per_plane
int	decode_pitch
int	bytes_to_allocate
CL_InputSourceProvider*	provider
int	pitch
int	height
int	bounding_left
int	bounding_top
int	bounding_right
int	bounding_bottom
bool	transparent
int	trans_col
std::string	name
EPixelFormat	pixelformat
CL_Palette*	palette
unsigned char*	image

---

Detailed Description

clanDisplay="Surface Providers".

Definition at line 26 of file provider_pcx.h.

---

Constructor & Destructor Documentation

CL_PCXProvider::CL_PCXProvider ( std::string name, CL_InputSourceProvider * provider, bool transparent = false, unsigned char trans_col = 0 )

CL_PCXProvider::~CL_PCXProvider ( ) [virtual]

param: name - Name of the pcx file to load.param: provider - Input source provider that delivers the pcx 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_PCXProvider::create ( std::string handle, CL_InputSourceProvider * provider, bool transparent = false, unsigned char trans_col = 0 ) [static]

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target. Definition at line 112 of file provider_pcx.h.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_Target. Definition at line 87 of file provider_pcx.h.

unsigned int CL_PCXProvider::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 90 of file provider_pcx.h.

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

Reimplemented from CL_Target. Definition at line 102 of file provider_pcx.h.

unsigned int CL_PCXProvider::get_pitch ( ) const [inline, virtual]

Reimplemented from CL_Target. Definition at line 75 of file provider_pcx.h.

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

Reimplemented from CL_Target.

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

Reimplemented from CL_SurfaceProvider. Definition at line 109 of file provider_pcx.h.

int CL_PCXProvider::get_translate_x ( ) const [inline, virtual]

Reimplemented from CL_SurfaceProvider. Definition at line 78 of file provider_pcx.h.

int CL_PCXProvider::get_translate_y ( ) const [inline, virtual]

retval: The x-offset of the surface data. Reimplemented from CL_SurfaceProvider. Definition at line 81 of file provider_pcx.h.

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

Reimplemented from CL_Target. Definition at line 84 of file provider_pcx.h.

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

Reimplemented from CL_Target. Definition at line 105 of file provider_pcx.h.

virtual void CL_PCXProvider::perform_lock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

virtual void CL_PCXProvider::perform_unlock ( ) [virtual]

Reimplemented from CL_SurfaceProvider_Generic.

virtual void CL_PCXProvider::read_data ( ) [virtual]

virtual void CL_PCXProvider::read_header ( CL_InputSource * _datafile ) [virtual]

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

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

---

Member Data Documentation

unsigned char CL_PCXProvider::bits_per_pixel_per_plane [private]

Definition at line 133 of file provider_pcx.h.

int CL_PCXProvider::bounding_bottom [private]

Definition at line 142 of file provider_pcx.h.

int CL_PCXProvider::bounding_left [private]

Definition at line 142 of file provider_pcx.h.

int CL_PCXProvider::bounding_right [private]

Definition at line 142 of file provider_pcx.h.

int CL_PCXProvider::bounding_top [private]

Definition at line 142 of file provider_pcx.h.

int CL_PCXProvider::bytes_to_allocate [private]

Definition at line 135 of file provider_pcx.h.

int CL_PCXProvider::decode_pitch [private]

Definition at line 134 of file provider_pcx.h.

int CL_PCXProvider::dest_num_planes [private]

Definition at line 131 of file provider_pcx.h.

int CL_PCXProvider::height [private]

Definition at line 141 of file provider_pcx.h.

unsigned char* CL_PCXProvider::image [private]

Definition at line 149 of file provider_pcx.h.

std::string CL_PCXProvider::name [private]

Definition at line 145 of file provider_pcx.h.

int CL_PCXProvider::num_planes [private]

Definition at line 130 of file provider_pcx.h.

CL_Palette* CL_PCXProvider::palette [private]

Definition at line 148 of file provider_pcx.h.

unsigned char CL_PCXProvider::pcx_version [private]

Definition at line 133 of file provider_pcx.h.

int CL_PCXProvider::pitch [private]

Definition at line 140 of file provider_pcx.h.

EPixelFormat CL_PCXProvider::pixelformat [private]

Definition at line 146 of file provider_pcx.h.

CL_InputSourceProvider* CL_PCXProvider::provider [private]

Definition at line 139 of file provider_pcx.h.

int CL_PCXProvider::size_data [private]

Definition at line 132 of file provider_pcx.h.

int CL_PCXProvider::trans_col [private]

Definition at line 144 of file provider_pcx.h.

bool CL_PCXProvider::transparent [private]

Definition at line 143 of file provider_pcx.h.

---

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

• provider_pcx.h

---