CEGUI::OpenGLViewportTarget Class Reference

OpenGL implementation of a RenderTarget that represents am on-scren viewport. More...

Inheritance diagram for CEGUI::OpenGLViewportTarget:

Collaboration diagram for CEGUI::OpenGLViewportTarget:

Public Member Functions
	OpenGLViewportTarget (OpenGLRendererBase &owner)
	Construct a default OpenGLViewportTarget that uses the currently defined OpenGL viewport as it's initial area.
	OpenGLViewportTarget (OpenGLRendererBase &owner, const Rectf &area)
	Construct a OpenGLViewportTarget 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::OpenGLRenderTarget<>
	OpenGLRenderTarget (OpenGLRendererBase &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::OpenGLRenderTarget<>
virtual void	updateMatrix () const
	helper that initialises the cached matrix
Protected Attributes inherited from CEGUI::OpenGLRenderTarget<>
OpenGLRendererBase &	d_owner
	OpenGLRendererBase that created this object.
Rectf	d_area
	holds defined area for the RenderTarget
mat4Pimpl *	d_matrix
	saved copy of projection matrix
bool	d_matrixValid
	true if saved matrix is up to date
double	d_viewDistance
	tracks viewing distance (this is set up at the same time as d_matrix)
Static Protected Attributes inherited from CEGUI::OpenGLRenderTarget<>
static const double	d_yfov_tan
	tangent of the y FOV half-angle; used to calculate viewing distance.

Detailed Description

OpenGL implementation of a RenderTarget that represents am on-scren viewport.

Constructor & Destructor Documentation

CEGUI::OpenGLViewportTarget::OpenGLViewportTarget	(	OpenGLRendererBase &	owner,
		const Rectf &	area
	)

Construct a OpenGLViewportTarget 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::OpenGLViewportTarget::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.