Crazy Eddie's GUI System  0.8.4
CEGUI::TextureTarget Class Reference

Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that are implemented using textures. More...

Inherits CEGUI::RenderTarget.

Inherited by CEGUI::Direct3D10RenderTarget< TextureTarget >, CEGUI::Direct3D11RenderTarget< TextureTarget >, CEGUI::Direct3D9RenderTarget< TextureTarget >, CEGUI::IrrlichtRenderTarget< TextureTarget >, CEGUI::NullRenderTarget< TextureTarget >, CEGUI::OgreRenderTarget< TextureTarget >, CEGUI::OpenGLESRenderTarget< TextureTarget >, and CEGUI::OpenGLRenderTarget< TextureTarget >.

+ Collaboration diagram for CEGUI::TextureTarget:

List of all members.

Public Member Functions

virtual void clear ()=0
 Clear the surface of the underlying texture.
virtual TexturegetTexture () const =0
 Return a pointer to the CEGUI::Texture that the TextureTarget is using.
virtual void declareRenderSize (const Sizef &sz)=0
 Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations.
virtual bool isRenderingInverted () const =0
 Return whether rendering done on the target texture is inverted in relation to regular textures.

Detailed Description

Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that are implemented using textures.


Member Function Documentation

virtual void CEGUI::TextureTarget::declareRenderSize ( const Sizef sz) [pure 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:
szSize object describing the largest area that will be rendererd in the next batch of rendering operations.
Exceptions:
InvalidRequestExceptionMay be thrown if the TextureTarget would not be able to handle the operations rendering content of the given size.

Implemented in CEGUI::Direct3D9TextureTarget, CEGUI::Direct3D10TextureTarget, CEGUI::Direct3D11TextureTarget, CEGUI::IrrlichtTextureTarget, CEGUI::OpenGLWGLPBTextureTarget, CEGUI::OpenGLESFBOTextureTarget, CEGUI::OpenGL3FBOTextureTarget, CEGUI::OpenGLFBOTextureTarget, CEGUI::NullTextureTarget, CEGUI::OgreTextureTarget, CEGUI::OpenGLGLXPBTextureTarget, and CEGUI::OpenGLApplePBTextureTarget.

virtual bool CEGUI::TextureTarget::isRenderingInverted ( ) const [pure 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.

Implemented in CEGUI::Direct3D9TextureTarget, CEGUI::Direct3D10TextureTarget, CEGUI::Direct3D11TextureTarget, CEGUI::IrrlichtTextureTarget, CEGUI::OpenGLESFBOTextureTarget, CEGUI::OpenGLTextureTarget, CEGUI::NullTextureTarget, and CEGUI::OgreTextureTarget.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends