CEGUI::Direct3D9ViewportTarget Class Reference

Direct3D9 RenderTarget that represents a screen viewport. More...

Inheritance diagram for CEGUI::Direct3D9ViewportTarget:

Collaboration diagram for CEGUI::Direct3D9ViewportTarget:

Public Member Functions
	Direct3D9ViewportTarget (Direct3D9Renderer &owner)
	Construct a default Direct3D9ViewportTarget that uses the current Direct3D9 viewport as it's initial area.
	Direct3D9ViewportTarget (Direct3D9Renderer &owner, const Rectf &area)
	Construct a Direct3D9ViewportTarget that uses the specified Rect as it's initial area. More...
bool	isImageryCache () const
	Return whether the RenderTarget is an implementation that caches actual rendered imagery. 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 Rectf &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 Rectf &	getArea () 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 Vector2f &p_in, Vector2f &p_out) const
	Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.

Additional Inherited Members
Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator < EventMap >	EventIterator
Static Public Attributes inherited from CEGUI::RenderTarget
static const String	EventNamespace
	Namespace for global events.
static const String	EventAreaChanged
Protected Types inherited from CEGUI::EventSet
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)>	EventMap
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 inherited from CEGUI::Direct3D9RenderTarget<>
Direct3D9Renderer &	d_owner
	Direct3D9Renderer that created this object.
LPDIRECT3DDEVICE9	d_device
	Direct3DDevice9 interface obtained from our owner.
Rectf	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)

Detailed Description

Direct3D9 RenderTarget that represents a screen viewport.

Constructor & Destructor Documentation

CEGUI::Direct3D9ViewportTarget::Direct3D9ViewportTarget	(	Direct3D9Renderer &	owner,
		const Rectf &	area
	)

Construct a Direct3D9ViewportTarget that uses the specified Rect as it's initial area.

Parameters

area	Rect object describing the initial viewport area that should be used for the RenderTarget.

Member Function Documentation

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