Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes

CEGUI::IrrlichtTextureTarget Class Reference

CEGUI::TextureTarget implementation for the Irrlicht engine. More...

Inheritance diagram for CEGUI::IrrlichtTextureTarget:
Collaboration diagram for CEGUI::IrrlichtTextureTarget:

List of all members.

Public Member Functions

 IrrlichtTextureTarget (IrrlichtRenderer &owner, irr::video::IVideoDriver &driver)
 Constructor.
virtual ~IrrlichtTextureTarget ()
 Destructor.
void activate ()
 Activate the render target and put it in a state ready to be drawn to.
void deactivate ()
 Deactivate the render target after having completed rendering.
bool isImageryCache () const
 Return whether the RenderTarget is an implementation that caches actual rendered imagery.
void clear ()
 Clear the surface of the underlying texture.
TexturegetTexture () const
 Return a pointer to the CEGUI::Texture that the TextureTarget is using.
void declareRenderSize (const Size &sz)
 Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations.
bool isRenderingInverted () const
 Return whether rendering done on the target texture is inverted in relation to regular textures.

Protected Member Functions

void cleanupTargetTexture ()
 cleans up the current render target texture used by this object.

Protected Attributes

irr::video::ITexture * d_texture
 The irrlicht render target texture we'll be drawing to.
IrrlichtTextured_CEGUITexture
 This wraps d_texture so it can be used by the core CEGUI lib.

Static Protected Attributes

static const float DEFAULT_SIZE
 default / initial size for the underlying texture.

Detailed Description

CEGUI::TextureTarget implementation for the Irrlicht engine.


Member Function Documentation

void CEGUI::IrrlichtTextureTarget::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::IrrlichtTextureTarget::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::IrrlichtTextureTarget::declareRenderSize ( const Size sz  )  [virtual]

Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations.

Note:
The main purpose of this is to allow for the implemenatation to resize the underlying texture so that it can hold the imagery that will be drawn.
Parameters:
sz Size object describing the largest area that will be rendererd in the next batch of rendering operations.
Exceptions:
InvalidRequestException May be thrown if the TextureTarget would not be able to handle the operations rendering content of the given size.

Implements CEGUI::TextureTarget.

Texture& CEGUI::IrrlichtTextureTarget::getTexture (  )  const [virtual]

Return a pointer to the CEGUI::Texture that the TextureTarget is using.

Returns:
Texture object that the TextureTarget uses when rendering imagery.

Implements CEGUI::TextureTarget.

bool CEGUI::IrrlichtTextureTarget::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.

bool CEGUI::IrrlichtTextureTarget::isRenderingInverted (  )  const [virtual]

Return whether rendering done on the target texture is inverted in relation to regular textures.

This is intended to be used when generating geometry for rendering the TextureTarget onto another surface.

Returns:
  • true if the texture content should be considered as inverted vertically in comparison with other regular textures.
  • false if the texture content has the same orientation as regular textures.

Implements CEGUI::TextureTarget.