---

CL_Surface Class Reference

#include <surface.h>

Inheritance diagram for CL_Surface:

[legend]Collaboration diagram for CL_Surface:

[legend]List of all members.

Public Methods
	CL_Surface ()
	param: provider - Image source.param: delete_provider - If true, the surface will delete the provider when deleted itself.retval: The surface created.construction:.
	CL_Surface (CL_SurfaceProvider *provider, bool delete_provider=false, bool dynamic=false, class CL_Resource *resource=NULL)
	CL_Surface (const char *resource_id, CL_ResourceManager *manager)
	param: provider - Image source.param: delete_provider - If true, the surface will delete the provider when deleted itself.param: dynamic - If true, a dynamic blitter will be chosen. If false, a caching blitter will be used.retval: The surface created.
	CL_Surface (const CL_Surface &surface)
virtual	~CL_Surface ()
	operator bool () const
	functions:.
const CL_Surface&	operator= (const CL_Surface &surf)
void	reload ()
CL_SurfaceProvider*	get_provider () const
void	put_screen (int x, int y, int spr_no=0, CL_DisplayCard *card=NULL)
	retval: Surface provider used by this surface.info: Display functions.
void	put_screen (int x, int y, float scale_x, float scale_y, int spr_no=0, CL_DisplayCard *card=NULL)
	param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: spr_no - subsprite number to use.param: card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.
void	put_screen (int x, int y, int size_x, int size_y, int spr_no=0, CL_DisplayCard *card=NULL)
	param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: scale_x - scale x multiplyer.param: scale_y - scale y multiplyer.param: spr_no - subsprite number to use.param: card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.
void	put_target (int x, int y, int spr_no, CL_Target *target)
	param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: size_x - width of the image when scaled.param: size_y - height of the image when scaled.param: spr_no - subsprite number to use.param: card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.
unsigned int	get_width () const
	param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: spr_no - subsprite number to use.param: target - target.
unsigned int	get_height () const
unsigned int	get_num_frames () const
bool	is_video (CL_DisplayCard *card=NULL) const
bool	is_loaded (CL_DisplayCard *card=NULL) const
bool	convert_video (CL_DisplayCard *card=NULL)
bool	convert_system (CL_DisplayCard *card=NULL)
void	flush (CL_DisplayCard *card=NULL)
	CL_Surface (class CL_Surface_Generic *impl)
	implementation:.
Public Attributes
class CL_Surface_Generic*	impl
Static Public Methods
CL_Surface*	load (const char *resource_id, CL_ResourceManager *manager)
	static_init:.
CL_Surface*	create (CL_SurfaceProvider *provider, bool delete_provider=false)
CL_Surface*	create_dynamic (CL_SurfaceProvider *provider, bool delete_provider=false)
	param: provider - Image source.param: delete_provider - If true, the surface will delete the provider when deleted itself.retval: The surface created.

---

Constructor & Destructor Documentation

CL_Surface::CL_Surface ( )

param: provider - Image source.param: delete_provider - If true, the surface will delete the provider when deleted itself.retval: The surface created.construction:.

CL_Surface::CL_Surface ( CL_SurfaceProvider * provider, bool delete_provider = false, bool dynamic = false, class CL_Resource * resource = NULL )

CL_Surface::CL_Surface ( const char * resource_id, CL_ResourceManager * manager )

param: provider - Image source.param: delete_provider - If true, the surface will delete the provider when deleted itself.param: dynamic - If true, a dynamic blitter will be chosen. If false, a caching blitter will be used.retval: The surface created.

CL_Surface::CL_Surface ( const CL_Surface & surface )

virtual CL_Surface::~CL_Surface ( ) [virtual]

CL_Surface::CL_Surface ( class CL_Surface_Generic * impl )

implementation:.

---

Member Function Documentation

bool CL_Surface::convert_system ( CL_DisplayCard * card = NULL )

Referenced by toluaI_CL_Surface_convert_system0().

bool CL_Surface::convert_video ( CL_DisplayCard * card = NULL )

Referenced by toluaI_CL_Surface_convert_video0().

CL_Surface* CL_Surface::create ( CL_SurfaceProvider * provider, bool delete_provider = false ) [static]

Referenced by CL_DynamicProvider::create(), CL_Canvas::create(), and toluaI_CL_Surface_create0().

CL_Surface* CL_Surface::create_dynamic ( CL_SurfaceProvider * provider, bool delete_provider = false ) [static]

param: provider - Image source.param: delete_provider - If true, the surface will delete the provider when deleted itself.retval: The surface created.

void CL_Surface::flush ( CL_DisplayCard * card = NULL )

Referenced by toluaI_CL_Surface_flush0().

unsigned int CL_Surface::get_height ( ) const

Referenced by toluaI_CL_Surface_get_height0().

unsigned int CL_Surface::get_num_frames ( ) const

Referenced by toluaI_CL_Surface_get_num_frames0().

CL_SurfaceProvider* CL_Surface::get_provider ( ) const

Referenced by toluaI_CL_Surface_get_provider0().

unsigned int CL_Surface::get_width ( ) const

param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: spr_no - subsprite number to use.param: target - target. Referenced by toluaI_CL_Surface_get_width0().

bool CL_Surface::is_loaded ( CL_DisplayCard * card = NULL ) const

Referenced by toluaI_CL_Surface_is_loaded0().

bool CL_Surface::is_video ( CL_DisplayCard * card = NULL ) const

Referenced by toluaI_CL_Surface_is_video0().

CL_Surface* CL_Surface::load ( const char * resource_id, CL_ResourceManager * manager ) [static]

static_init:. Referenced by Y_TEXT_OFFSET(), and toluaI_CL_Surface_load0().

CL_Surface::operator bool ( ) const

functions:.

const CL_Surface& CL_Surface::operator= ( const CL_Surface & surf )

void CL_Surface::put_screen ( int x, int y, int size_x, int size_y, int spr_no = 0, CL_DisplayCard * card = NULL )

param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: scale_x - scale x multiplyer.param: scale_y - scale y multiplyer.param: spr_no - subsprite number to use.param: card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.

void CL_Surface::put_screen ( int x, int y, float scale_x, float scale_y, int spr_no = 0, CL_DisplayCard * card = NULL )

param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: spr_no - subsprite number to use.param: card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display.

void CL_Surface::put_screen ( int x, int y, int spr_no = 0, CL_DisplayCard * card = NULL )

retval: Surface provider used by this surface.info: Display functions. Referenced by toluaI_CL_Surface_put_screen0(), toluaI_CL_Surface_put_screen1(), and toluaI_CL_Surface_put_screen2().

void CL_Surface::put_target ( int x, int y, int spr_no, CL_Target * target )

param: x - x coordinate to draw surface.param: y - y coordinate to draw surface.param: size_x - width of the image when scaled.param: size_y - height of the image when scaled.param: spr_no - subsprite number to use.param: card - Display card to be drawn onto. If NULL it will use the currently selected video card by CL_Display. Referenced by toluaI_CL_Surface_put_target0().

void CL_Surface::reload ( )

Referenced by toluaI_CL_Surface_reload0().

---

Member Data Documentation

class CL_Surface_Generic* CL_Surface::impl

Definition at line 213 of file surface.h.

---

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

• surface.h

---