deDSRenderableCanvas Class Reference

Dynamic skin renderable canvas. More...

#include <deDSRenderableCanvas.h>

Inheritance diagram for deDSRenderableCanvas:

Public Member Functions
Constructors and Destructors
	deDSRenderableCanvas (const char *name)
	Create renderable. More...
virtual	~deDSRenderableCanvas ()
	Clean up renderable. More...
Management
int	GetComponentCount () const
	Number of components. More...
void	SetComponentCount (int componentCount)
	Set number of components. More...
int	GetBitCount () const
	Bit count of each component. More...
void	SetBitCount (int bitCount)
	Set bit count of each component. More...
deCanvasView *	GetCanvas () const
	Canvas view or NULL if not set. More...
void	SetCanvas (deCanvasView *canvas)
	Set canvas view or NULL if not set. More...
Visiting
virtual void	Visit (deDSRenderableVisitor &visitor)
	Visit the renderable. More...
Public Member Functions inherited from deDSRenderable
	deDSRenderable (const char *name)
	Create new renderable. More...
virtual	~deDSRenderable ()
	Clean up renderable. More...
const decString &	GetName () const
	Name. More...

Detailed Description

Dynamic skin renderable canvas.

The texture is defined using the content of a temporary render target. Temporary render targets are not created by the user but by the Graphic Module on the fly if required and for as long as it is required. The user only specifies the content using a deCanvasView. This allows the Graphic Module to use GPU memory efficiently. In general the size of the canvas view defines the size of the used render target but the Graphic Module is free to choose a fitting size itself.

Constructor & Destructor Documentation

deDSRenderableCanvas()

deDSRenderableCanvas::deDSRenderableCanvas

(

const char *

name

)

Create renderable.

~deDSRenderableCanvas()

virtual deDSRenderableCanvas::~deDSRenderableCanvas ( )

virtual

Clean up renderable.

Member Function Documentation

GetBitCount()

int deDSRenderableCanvas::GetBitCount ( ) const

inline

Bit count of each component.

GetCanvas()

deCanvasView* deDSRenderableCanvas::GetCanvas ( ) const

inline

Canvas view or NULL if not set.

GetComponentCount()

int deDSRenderableCanvas::GetComponentCount ( ) const

inline

Number of components.

SetBitCount()

void deDSRenderableCanvas::SetBitCount

(

int

bitCount

)

Set bit count of each component.

Exceptions

deeInvalidParam

bitCount is not 8, 16 or 32.

SetCanvas()

void deDSRenderableCanvas::SetCanvas

(

deCanvasView *

canvas

)

Set canvas view or NULL if not set.

SetComponentCount()

void deDSRenderableCanvas::SetComponentCount

(

int

componentCount

)

Set number of components.

Exceptions

deeInvalidParam	componentCount is less than 1.
deeInvalidParam	componentCount is greater than 4.

Visit()

virtual void deDSRenderableCanvas::Visit ( deDSRenderableVisitor &  visitor )

virtual

Visit the renderable.

Reimplemented from deDSRenderable.

---

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

• deDSRenderableCanvas.h