CEGUI::Direct3D9TextureTarget Class Reference

Direct3D9TextureTarget - allows rendering to an Direct3D9 texture via . More...

Inheritance diagram for CEGUI::Direct3D9TextureTarget:

Collaboration diagram for CEGUI::Direct3D9TextureTarget:

Public Member Functions
	Direct3D9TextureTarget (Direct3D9Renderer &owner)
void	preD3DReset ()
	auto called via the Renderer prior to Reset on the Direct3DDevice9.
void	postD3DReset ()
	auto called via the Renderer after Reset on the Direct3DDevice9.
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...
bool	isImageryCache () const
	Return whether the RenderTarget is an implementation that caches actual rendered imagery. More...
void	clear ()
	Clear the surface of the underlying texture.
Texture &	getTexture () const
	Return a pointer to the CEGUI::Texture that the TextureTarget is using. More...
void	declareRenderSize (const Size &sz)
	Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations. More...
bool	isRenderingInverted () const
	Return whether rendering done on the target texture is inverted in relation to regular textures. More...
Public Member Functions inherited from CEGUI::Direct3D9RenderTarget
	Direct3D9RenderTarget (Direct3D9Renderer &owner)
	Constructor.
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 Rect &	getArea () const
	Return the area defined for this RenderTarget. 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.
Public Member Functions inherited from CEGUI::RenderTarget
virtual	~RenderTarget ()
	Destructor.

Protected Member Functions
void	initialiseRenderTexture ()
	allocate and set up the texture used for rendering.
void	cleanupRenderTexture ()
	clean up the texture used for rendering.
void	resizeRenderTexture ()
	resize the texture
void	enableRenderTexture ()
	switch to the texture surface & depth buffer
void	disableRenderTexture ()
	switch back to previous surface
Protected Member Functions inherited from CEGUI::Direct3D9RenderTarget
void	updateMatrix () const
	helper that initialises the cached matrix
void	setupViewport (D3DVIEWPORT9 &vp) const
	helper to initialise the D3DVIEWPORT9 vp for this target.

Protected Attributes
LPDIRECT3DTEXTURE9	d_texture
	Direct3D9 texture that's rendered to.
LPDIRECT3DSURFACE9	d_surface
	Direct3D9 surface for the texture.
Direct3D9Texture *	d_CEGUITexture
	we use this to wrap d_texture so it can be used by the core CEGUI lib.
LPDIRECT3DSURFACE9	d_prevColourSurface
	colour surface that was in use before this target was activated.
Protected Attributes inherited from CEGUI::Direct3D9RenderTarget
Direct3D9Renderer &	d_owner
	Direct3D9Renderer that created this object.
LPDIRECT3DDEVICE9	d_device
	Direct3DDevice9 interface obtained from our owner.
Rect	d_area
	holds defined area for the RenderTarget
D3DXMATRIX	d_matrix
	projection / view matrix cache
bool	d_matrixValid
	true when d_matrix is valid and up to date
float	d_viewDistance
	tracks viewing distance (this is set up at the same time as d_matrix)

Static Protected Attributes
static const float	DEFAULT_SIZE
	default size of created texture objects

Detailed Description

Direct3D9TextureTarget - allows rendering to an Direct3D9 texture via .

Member Function Documentation

void CEGUI::Direct3D9TextureTarget::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.

Reimplemented from CEGUI::Direct3D9RenderTarget.

void CEGUI::Direct3D9TextureTarget::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.

Reimplemented from CEGUI::Direct3D9RenderTarget.

void CEGUI::Direct3D9TextureTarget::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::Direct3D9TextureTarget::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::Direct3D9TextureTarget::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

• true if the RenderTarget does cache rendered imagery.
• false if the RenderTarget does not cache rendered imagery.

Implements CEGUI::RenderTarget.

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