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::Direct3D10TextureTarget, CEGUI::Direct3D11TextureTarget, CEGUI::Direct3D9TextureTarget, CEGUI::IrrlichtTextureTarget, CEGUI::NullTextureTarget, CEGUI::OgreTextureTarget, and CEGUI::OpenGLTextureTarget.

Collaboration diagram for CEGUI::TextureTarget:

Public Member Functions
virtual void	clear ()=0
	Clear the surface of the underlying texture.

virtual Texture &	getTexture () const =0
	Return a pointer to the CEGUI::Texture that the TextureTarget is using. More...

virtual void	declareRenderSize (const Size &sz)=0
	Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations. More...

virtual bool	isRenderingInverted () const =0
	Return whether rendering done on the target texture is inverted in relation to regular textures. More...

Public Member Functions inherited from CEGUI::RenderTarget
virtual	~RenderTarget ()
	Destructor.

virtual void	draw (const GeometryBuffer &buffer)=0
	Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents. More...

virtual void	draw (const RenderQueue &queue)=0
	Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents. More...

virtual void	setArea (const Rect &area)=0
	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...

virtual const Rect &	getArea () const =0
	Return the area defined for this RenderTarget. More...

virtual bool	isImageryCache () const =0
	Return whether the RenderTarget is an implementation that caches actual rendered imagery. More...

virtual void	activate ()=0
	Activate the render target and put it in a state ready to be drawn to. More...

virtual void	deactivate ()=0
	Deactivate the render target after having completed rendering. More...

virtual void	unprojectPoint (const GeometryBuffer &buff, const Vector2 &p_in, Vector2 &p_out) const =0
	Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.

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 Size & 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

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.

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

virtual Texture& CEGUI::TextureTarget::getTexture ( ) const

pure virtual

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

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

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

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::NullTextureTarget, CEGUI::OgreTextureTarget, and CEGUI::OpenGLTextureTarget.

Public Member Functions

Detailed Description

Member Function Documentation