deRenderTarget Class Reference

Render Target Class. More...

#include <deRenderTarget.h>

Inheritance diagram for deRenderTarget:
deResource deObject

List of all members.

Public Member Functions

Constructors and Destructors
 deRenderTarget (deRenderTargetManager *manager, int width, int height, int componentCount, int bitCount, bool isPrimary)
 Creates a new render target with the given size.
virtual ~deRenderTarget ()
 Cleans up the render target.
Management
int GetWidth () const
 Retrieves the width in pixels.
int GetHeight () const
 Retrieves the height in pixels.
void SetSize (int width, int height)
 Sets the size of the render target.
int GetComponentCount () const
 Retrieves the number of components.
void SetComponentCount (int componentCount)
 Sets the component count.
int GetBitCount () const
 Retrieves the bit count of each component.
void SetBitCount (int bitCount)
 Sets the bit count.
bool GetIsPrimary () const
 Determines if the render target is the primary render target.
System Peers
deBaseGraphicRenderTargetGetGraphicTarget () const
 Retrieves the graphic system peer object.
void SetGraphicTarget (deBaseGraphicRenderTarget *target)
 Sets the graphic system peer object.

Detailed Description

Render Target Class.

Render targets provide drawable objects for providing output to the screen. There exists one primary render target and optionally multiple non-visible render targets.

Author:
Plüss Roland
Version:
1.0
Date:
2008

Constructor & Destructor Documentation

deRenderTarget::deRenderTarget ( deRenderTargetManager manager,
int  width,
int  height,
int  componentCount,
int  bitCount,
bool  isPrimary 
)

Creates a new render target with the given size.

virtual deRenderTarget::~deRenderTarget (  ) [virtual]

Cleans up the render target.


Member Function Documentation

int deRenderTarget::GetBitCount (  ) const [inline]

Retrieves the bit count of each component.

int deRenderTarget::GetComponentCount (  ) const [inline]

Retrieves the number of components.

deBaseGraphicRenderTarget* deRenderTarget::GetGraphicTarget (  ) const [inline]

Retrieves the graphic system peer object.

int deRenderTarget::GetHeight (  ) const [inline]

Retrieves the height in pixels.

bool deRenderTarget::GetIsPrimary (  ) const [inline]

Determines if the render target is the primary render target.

int deRenderTarget::GetWidth (  ) const [inline]

Retrieves the width in pixels.

void deRenderTarget::SetBitCount ( int  bitCount )

Sets the bit count.

void deRenderTarget::SetComponentCount ( int  componentCount )

Sets the component count.

void deRenderTarget::SetGraphicTarget ( deBaseGraphicRenderTarget target )

Sets the graphic system peer object.

void deRenderTarget::SetSize ( int  width,
int  height 
)

Sets the size of the render target.

This function only works on primary render targets and result in an exception on others.


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