Crazy Eddies GUI System  0.7.2
Public Member Functions | Protected Attributes | List of all members
CEGUI::NullRenderTarget Class Reference

Intermediate RenderTarget. More...

+ Inheritance diagram for CEGUI::NullRenderTarget:
+ Collaboration diagram for CEGUI::NullRenderTarget:

Public Member Functions

 NullRenderTarget (NullRenderer &owner)
 Constructor.
 
virtual ~NullRenderTarget ()
 Destructor.
 
void draw (const GeometryBuffer &buffer)
 Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents. More...
 
void draw (const RenderQueue &queue)
 Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents. More...
 
void setArea (const Rect &area)
 Set the area for this RenderTarget. The exact action this function will take depends upon what the concrete class is representing. For example, with a 'view port' style RenderTarget, this should set the area that the view port occupies on the display (or rendering window). More...
 
const RectgetArea () const
 Return the area defined for this RenderTarget. More...
 
void activate ()
 Activate the render target and put it in a state ready to be drawn to. More...
 
void deactivate ()
 Deactivate the render target after having completed rendering. More...
 
void unprojectPoint (const GeometryBuffer &buff, const Vector2 &p_in, Vector2 &p_out) const
 Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.
 
bool isImageryCache () const
 Return whether the RenderTarget is an implementation that caches actual rendered imagery. More...
 
- Public Member Functions inherited from CEGUI::RenderTarget
virtual ~RenderTarget ()
 Destructor.
 

Protected Attributes

NullRendererd_owner
 NullRenderer object that owns this RenderTarget.
 
Rect d_area
 holds defined area for the RenderTarget
 

Detailed Description

Intermediate RenderTarget.

Member Function Documentation

void CEGUI::NullRenderTarget::activate ( )
virtual

Activate the render target and put it in a state ready to be drawn to.

Note
You MUST call this before doing any rendering - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Implements CEGUI::RenderTarget.

void CEGUI::NullRenderTarget::deactivate ( )
virtual

Deactivate the render target after having completed rendering.

Note
You MUST call this after you finish rendering to the target - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Implements CEGUI::RenderTarget.

void CEGUI::NullRenderTarget::draw ( const GeometryBuffer buffer)
virtual

Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents.

Parameters
bufferGeometryBuffer object holding the geometry that should be drawn to the RenderTarget.

Implements CEGUI::RenderTarget.

void CEGUI::NullRenderTarget::draw ( const RenderQueue queue)
virtual

Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents.

Parameters
queueRenderQueue object holding the geometry that should be drawn to the RenderTarget.

Implements CEGUI::RenderTarget.

const Rect& CEGUI::NullRenderTarget::getArea ( ) const
virtual

Return the area defined for this RenderTarget.

Returns
Rect object describing the currently defined area for this RenderTarget.

Implements CEGUI::RenderTarget.

bool CEGUI::NullRenderTarget::isImageryCache ( ) const
virtual

Return whether the RenderTarget is an implementation that caches actual rendered imagery.

Typically it is expected that texture based RenderTargets would return
true in response to this call.  Other types of RenderTarget, like
view port based targets, will more likely return false.
Returns

Implements CEGUI::RenderTarget.

Reimplemented in CEGUI::NullTextureTarget.

void CEGUI::NullRenderTarget::setArea ( const Rect area)
virtual

Set the area for this RenderTarget. The exact action this function will take depends upon what the concrete class is representing. For example, with a 'view port' style RenderTarget, this should set the area that the view port occupies on the display (or rendering window).

Parameters
areaRect object describing the new area to be assigned to the RenderTarget.
Exceptions
InvalidRequestExceptionMay be thrown if the RenderTarget does not support setting or changing its area, or if the area change can not be satisfied for some reason.

Implements CEGUI::RenderTarget.