Ogre::RenderTarget Class Reference
[RenderSystem]

A 'canvas' which can receive the results of a rendering operation. More...

#include <OgreRenderTarget.h>

Inheritance diagram for Ogre::RenderTarget:

[legend]

Classes
struct	FrameStats
class	Impl
	RenderSystem specific interface for a RenderTarget; this should be subclassed by RenderSystems. More...
Public Types
enum	StatFlags { SF_NONE = 0, SF_FPS = 1, SF_AVG_FPS = 2, SF_BEST_FPS = 4, SF_WORST_FPS = 8, SF_TRIANGLE_COUNT = 16, SF_ALL = 0xFFFF }
enum	FrameBuffer { FB_FRONT, FB_BACK, FB_AUTO }
Public Member Functions
	RenderTarget ()
virtual	~RenderTarget ()
virtual const String &	getName (void) const
	Retrieve target's name.
virtual void	getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
	Retrieve information about the render target.
virtual unsigned int	getWidth (void) const
virtual unsigned int	getHeight (void) const
virtual unsigned int	getColourDepth (void) const
void	setDepthBufferPool (uint16 poolId)
	Sets the pool ID this RenderTarget should query from.
uint16	getDepthBufferPool () const
DepthBuffer *	getDepthBuffer () const
virtual bool	attachDepthBuffer (DepthBuffer *depthBuffer)
virtual void	detachDepthBuffer ()
virtual void	_detachDepthBuffer ()
	Detaches DepthBuffer without notifying it from the detach.
virtual void	update (bool swapBuffers=true)
	Tells the target to update it's contents.
virtual void	swapBuffers (bool waitForVSync=true)
	Swaps the frame buffers to display the next frame.
virtual Viewport *	addViewport (Camera *cam, int ZOrder=0, float left=0.0f, float top=0.0f, float width=1.0f, float height=1.0f)
	Adds a viewport to the rendering target.
virtual unsigned short	getNumViewports (void) const
	Returns the number of viewports attached to this target.
virtual Viewport *	getViewport (unsigned short index)
	Retrieves a pointer to the viewport with the given index.
virtual Viewport *	getViewportByZOrder (int ZOrder)
	Retrieves a pointer to the viewport with the given zorder.
virtual bool	hasViewportWithZOrder (int ZOrder)
	Returns true if and only if a viewport exists at the given ZOrder.
virtual void	removeViewport (int ZOrder)
	Removes a viewport at a given ZOrder.
virtual void	removeAllViewports (void)
	Removes all viewports on this target.
virtual void	getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) const
	Retieves details of current rendering performance.
virtual const FrameStats &	getStatistics (void) const
virtual float	getLastFPS () const
	Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.
virtual float	getAverageFPS () const
	Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering.
virtual float	getBestFPS () const
	Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering.
virtual float	getWorstFPS () const
	Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering.
virtual float	getBestFrameTime () const
	Individual stats access - gets the best frame time.
virtual float	getWorstFrameTime () const
	Individual stats access - gets the worst frame time.
virtual void	resetStatistics (void)
	Resets saved frame-rate statistices.
virtual void	getCustomAttribute (const String &name, void *pData)
	Gets a custom (maybe platform-specific) attribute.
virtual void	addListener (RenderTargetListener *listener)
	Add a listener to this RenderTarget which will be called back before & after rendering.
virtual void	removeListener (RenderTargetListener *listener)
	Removes a RenderTargetListener previously registered using addListener.
virtual void	removeAllListeners (void)
	Removes all listeners from this instance.
virtual void	setPriority (uchar priority)
	Sets the priority of this render target in relation to the others.
virtual uchar	getPriority () const
	Gets the priority of a render target.
virtual bool	isActive () const
	Used to retrieve or set the active state of the render target.
virtual void	setActive (bool state)
	Used to set the active state of the render target.
virtual void	setAutoUpdated (bool autoupdate)
	Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
virtual bool	isAutoUpdated (void) const
	Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
virtual void	copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)=0
	Copies the current contents of the render target to a pixelbox.
virtual PixelFormat	suggestPixelFormat () const
	Suggests a pixel format to use for extracting the data in this target, when calling copyContentsToMemory.
void	writeContentsToFile (const String &filename)
	Writes the current contents of the render target to the named file.
virtual String	writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
	Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.
virtual bool	requiresTextureFlipping () const =0
virtual size_t	getTriangleCount (void) const
	Gets the number of triangles rendered in the last update() call.
virtual size_t	getBatchCount (void) const
	Gets the number of batches rendered in the last update() call.
virtual void	_notifyCameraRemoved (const Camera *cam)
	Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.
virtual bool	isPrimary (void) const
	Indicates whether this target is the primary window.
virtual bool	isHardwareGammaEnabled () const
	Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space.
virtual uint	getFSAA () const
	Indicates whether multisampling is performed on rendering and at what level.
virtual const String &	getFSAAHint () const
	Gets the FSAA hint (.
virtual Impl *	_getImpl ()
	Get rendersystem specific interface for this RenderTarget.
virtual void	_beginUpdate ()
	Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc.
virtual void	_updateViewport (int zorder, bool updateStatistics=true)
	Method for manual management of rendering - renders the given viewport (even if it is not autoupdated).
virtual void	_updateViewport (Viewport *viewport, bool updateStatistics=true)
	Method for manual management of rendering - renders the given viewport (even if it is not autoupdated).
virtual void	_updateAutoUpdatedViewports (bool updateStatistics=true)
	Method for manual management of rendering - renders only viewports that are auto updated.
virtual void	_endUpdate ()
	Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Protected Types
typedef map< int, Viewport * > ::type	ViewportList
typedef vector < RenderTargetListener * > ::type	RenderTargetListenerList
Protected Member Functions
void	updateStats (void)
virtual void	firePreUpdate (void)
	internal method for firing events
virtual void	firePostUpdate (void)
	internal method for firing events
virtual void	fireViewportPreUpdate (Viewport *vp)
	internal method for firing events
virtual void	fireViewportPostUpdate (Viewport *vp)
	internal method for firing events
virtual void	fireViewportAdded (Viewport *vp)
	internal method for firing events
virtual void	fireViewportRemoved (Viewport *vp)
	internal method for firing events
virtual void	updateImpl ()
	Internal implementation of update().
Protected Attributes
String	mName
	The name of this target.
uchar	mPriority
	The priority of the render target.
unsigned int	mWidth
unsigned int	mHeight
unsigned int	mColourDepth
uint16	mDepthBufferPoolId
DepthBuffer *	mDepthBuffer
FrameStats	mStats
Timer *	mTimer
unsigned long	mLastSecond
unsigned long	mLastTime
size_t	mFrameCount
bool	mActive
bool	mAutoUpdate
bool	mHwGamma
uint	mFSAA
String	mFSAAHint
ViewportList	mViewportList
	List of viewports, map on Z-order.
RenderTargetListenerList	mListeners

Detailed Description

A 'canvas' which can receive the results of a rendering operation.

Remarks:: This abstract class defines a common root to all targets of rendering operations. A render target could be a window on a screen, or another offscreen surface like a texture or bump map etc.

Author:: Steven Streeting

Version:: 1.0

Definition at line 64 of file OgreRenderTarget.h.

Member Typedef Documentation

typedef vector<RenderTargetListener*>::type Ogre::RenderTarget::RenderTargetListenerList [protected]

Definition at line 509 of file OgreRenderTarget.h.

typedef map<int, Viewport*>::type Ogre::RenderTarget::ViewportList [protected]

Definition at line 505 of file OgreRenderTarget.h.

Member Enumeration Documentation

enum Ogre::RenderTarget::FrameBuffer

Enumerator:

FB_FRONT
FB_BACK
FB_AUTO

Definition at line 90 of file OgreRenderTarget.h.

enum Ogre::RenderTarget::StatFlags

Enumerator:

SF_NONE
SF_FPS
SF_AVG_FPS
SF_BEST_FPS
SF_WORST_FPS
SF_TRIANGLE_COUNT
SF_ALL

Definition at line 67 of file OgreRenderTarget.h.

Constructor & Destructor Documentation

Ogre::RenderTarget::RenderTarget ( )

virtual Ogre::RenderTarget::~RenderTarget ( ) [virtual]

Member Function Documentation

virtual void Ogre::RenderTarget::_beginUpdate ( ) [virtual]

Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc.

Remarks:

_beginUpdate resets statistics and fires 'preRenderTargetUpdate'.
_updateViewport renders the given viewport (even if it is not autoupdated), fires preViewportUpdate and postViewportUpdate and manages statistics.
_updateAutoUpdatedViewports renders only viewports that are auto updated, fires preViewportUpdate and postViewportUpdate and manages statistics.
_endUpdate() ends statistics calculation and fires postRenderTargetUpdate.

you can use it like this for example :

			renderTarget->_beginUpdate();
			renderTarget->_updateViewport(1); // which is not auto updated
			renderTarget->_updateViewport(2); // which is not auto updated
			renderTarget->_updateAutoUpdatedViewports();
			renderTarget->_endUpdate();
			renderTarget->swapBuffers(true);

Please note that in that case, the zorder may not work as you expect, since you are responsible for calling _updateViewport in the correct order.

virtual void Ogre::RenderTarget::_detachDepthBuffer ( ) [virtual]

Detaches DepthBuffer without notifying it from the detach.

Useful when called from the DepthBuffer while it iterates through attached RenderTargets (

See also:: DepthBuffer::_setPoolId())

virtual void Ogre::RenderTarget::_endUpdate ( ) [virtual]

Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'.

Remarks:: You should call it after a _beginUpdate

See also:: _beginUpdate for more details.

virtual Impl* Ogre::RenderTarget::_getImpl ( ) [virtual]

Get rendersystem specific interface for this RenderTarget.

This is used by the RenderSystem to (un)bind this target, and to get specific information like surfaces and framebuffer objects.

virtual void Ogre::RenderTarget::_notifyCameraRemoved ( const Camera * cam ) [virtual]

Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.

virtual void Ogre::RenderTarget::_updateAutoUpdatedViewports ( bool updateStatistics = true ) [virtual]

Method for manual management of rendering - renders only viewports that are auto updated.

Remarks:: This also fires preViewportUpdate and postViewportUpdate, and manages statistics. You should call it between _beginUpdate() and _endUpdate(). See _beginUpdate for more details.

Parameters:

updateStatistics

Whether you want to update statistics or not.

See also:: _beginUpdate()

virtual void Ogre::RenderTarget::_updateViewport	(	Viewport *	viewport,
		bool	updateStatistics = `true`
	)			`[virtual]`

Method for manual management of rendering - renders the given viewport (even if it is not autoupdated).

Remarks:: This also fires preViewportUpdate and postViewportUpdate, and manages statistics if needed. You should call it between _beginUpdate() and _endUpdate().

See also:: _beginUpdate for more details.

Parameters:

	viewport	The viewport you want to update, it must be bound to the rendertarget.
	updateStatistics	Whether you want to update statistics or not.

virtual void Ogre::RenderTarget::_updateViewport	(	int	zorder,
		bool	updateStatistics = `true`
	)			`[virtual]`

Method for manual management of rendering - renders the given viewport (even if it is not autoupdated).

Remarks:: This also fires preViewportUpdate and postViewportUpdate, and manages statistics. You should call it between _beginUpdate() and _endUpdate().

See also:: _beginUpdate for more details.

Parameters:

	zorder	The zorder of the viewport to update.
	updateStatistics	Whether you want to update statistics or not.

virtual void Ogre::RenderTarget::addListener ( RenderTargetListener * listener ) [virtual]

Add a listener to this RenderTarget which will be called back before & after rendering.

Remarks:: If you want notifications before and after a target is updated by the system, use this method to register your own custom RenderTargetListener class. This is useful for potentially adding your own manual rendering commands before and after the 'normal' system rendering.

NB this should not be used for frame-based scene updates, use Root::addFrameListener for that.

virtual Viewport* Ogre::RenderTarget::addViewport	(	Camera *	cam,
		int	ZOrder = `0`,
		float	left = `0.0f`,
		float	top = `0.0f`,
		float	width = `1.0f`,
		float	height = `1.0f`
	)			`[virtual]`

Adds a viewport to the rendering target.

Remarks:: A viewport is the rectangle into which rendering output is sent. This method adds a viewport to the render target, rendering from the supplied camera. The rest of the parameters are only required if you wish to add more than one viewport to a single rendering target. Note that size information passed to this method is passed as a parametric, i.e. it is relative rather than absolute. This is to allow viewports to automatically resize along with the target.

Parameters:

	cam	The camera from which the viewport contents will be rendered (mandatory)
	ZOrder	The relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher ZOrders are on top of lower ones. The actual number is irrelevant, only the relative ZOrder matters (you can leave gaps in the numbering)
	left	The relative position of the left of the viewport on the target, as a value between 0 and 1.
	top	The relative position of the top of the viewport on the target, as a value between 0 and 1.
	width	The relative width of the viewport on the target, as a value between 0 and 1.
	height	The relative height of the viewport on the target, as a value between 0 and 1.

virtual bool Ogre::RenderTarget::attachDepthBuffer ( DepthBuffer * depthBuffer ) [virtual]

virtual void Ogre::RenderTarget::copyContentsToMemory	(	const PixelBox &	dst,
		FrameBuffer	buffer = `FB_AUTO`
	)			`[pure virtual]`

Copies the current contents of the render target to a pixelbox.

Remarks:: See suggestPixelFormat for a tip as to the best pixel format to extract into, although you can use whatever format you like and the results will be converted.

Implemented in Ogre::RenderTexture, and Ogre::MultiRenderTarget.

virtual void Ogre::RenderTarget::detachDepthBuffer ( ) [virtual]

virtual void Ogre::RenderTarget::firePostUpdate ( void ) [protected, virtual]