Ogre::RenderTexture Class Reference

This class represents a RenderTarget that renders to a Texture. More...

#include <OgreRenderTexture.h>

Inheritance diagram for Ogre::RenderTexture:

List of all members.


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 }
Public Member Functions
	RenderTexture (HardwarePixelBuffer *buffer, size_t zoffset)
virtual	~RenderTexture ()
void	writeContentsToFile (const String &filename)
	Writes the current contents of the render target to the named file.
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
virtual void	update (void)
	Tells the target to update it's contents.
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 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	setDebugText (const String &text)
	Adds debug text to this window.
const String &	getDebugText () const
	Returns the debug text.
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 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 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 Impl *	_getImpl ()
	Get rendersystem specific interface for this RenderTarget.
Protected Types
typedef std::map< int, Viewport *, std::less< int > >	ViewportList
typedef std::vector< RenderTargetListener * >	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
Protected Attributes
HardwarePixelBuffer *	mBuffer
size_t	mZOffset
String	mName
	The name of this target.
uchar	mPriority
	The priority of the render target.
unsigned int	mWidth
unsigned int	mHeight
unsigned int	mColourDepth
bool	mIsDepthBuffered
FrameStats	mStats
Timer *	mTimer
String	mDebugText
unsigned long	mLastSecond
unsigned long	mLastTime
size_t	mFrameCount
bool	mActive
bool	mAutoUpdate
ViewportList	mViewportList
	List of viewports, map on Z-order.
RenderTargetListenerList	mListeners

Detailed Description

This class represents a RenderTarget that renders to a Texture.

There is no 1 on 1 relation between Textures and RenderTextures, as there can be multiple RenderTargets rendering to different mipmaps, faces (for cubemaps) or slices (for 3D textures) of the same Texture.

Definition at line 39 of file OgreRenderTexture.h.

Member Typedef Documentation

typedef std::vector<RenderTargetListener*> Ogre::RenderTarget::RenderTargetListenerList [protected, inherited]

Definition at line 339 of file OgreRenderTarget.h.

typedef std::map<int, Viewport*, std::less<int> > Ogre::RenderTarget::ViewportList [protected, inherited]

Definition at line 335 of file OgreRenderTarget.h.

Member Enumeration Documentation

enum Ogre::RenderTarget::StatFlags [inherited]

Enumeration values:

SF_NONE

SF_FPS

SF_AVG_FPS

SF_BEST_FPS

SF_WORST_FPS

SF_TRIANGLE_COUNT

SF_ALL

Definition at line 58 of file OgreRenderTarget.h.

Constructor & Destructor Documentation

Ogre::RenderTexture::RenderTexture ( HardwarePixelBuffer * buffer,

size_t zoffset

)

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

Member Function Documentation

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

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, inherited]

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::addListener ( RenderTargetListener * listener ) [virtual, inherited]

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, inherited]

Adds a viewport to the rendering target.

Remarks:
A viewport is the rectangle into which redering 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 void Ogre::RenderTarget::firePostUpdate ( void ) [protected, virtual, inherited]

internal method for firing events

virtual void Ogre::RenderTarget::firePreUpdate ( void ) [protected, virtual, inherited]

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportAdded ( Viewport * vp ) [protected, virtual, inherited]

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPostUpdate ( Viewport * vp ) [protected, virtual, inherited]

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPreUpdate ( Viewport * vp ) [protected, virtual, inherited]

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportRemoved ( Viewport * vp ) [protected, virtual, inherited]

internal method for firing events

virtual float Ogre::RenderTarget::getAverageFPS ( ) const [virtual, inherited]

Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getBestFPS ( ) const [virtual, inherited]

Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getBestFrameTime ( ) const [virtual, inherited]

Individual stats access - gets the best frame time.

virtual unsigned int Ogre::RenderTarget::getColourDepth ( void ) const [virtual, inherited]

virtual void Ogre::RenderTarget::getCustomAttribute ( const String & name,

void * pData

) [virtual, inherited]

Gets a custom (maybe platform-specific) attribute.

Remarks:
This is a nasty way of satisfying any API's need to see platform-specific details. It horrid, but D3D needs this kind of info. At least it's abstracted.

Parameters:

name The name of the attribute.

pData Pointer to memory of the right kind of structure to receive the info.

Reimplemented in Ogre::D3D9MultiRenderTarget, Ogre::D3D9RenderWindow, Ogre::D3D9RenderTexture, Ogre::GLXWindow, Ogre::GTKWindow, Ogre::GLFBOMultiRenderTarget, Ogre::GLFBORenderTexture, Ogre::GLPBRenderTexture, Ogre::GLCopyingRenderTexture, Ogre::SDLWindow, and Ogre::Win32Window.

const String& Ogre::RenderTarget::getDebugText ( ) const [inherited]

Returns the debug text.

virtual unsigned int Ogre::RenderTarget::getHeight ( void ) const [virtual, inherited]

virtual float Ogre::RenderTarget::getLastFPS ( ) const [virtual, inherited]

Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.

virtual void Ogre::RenderTarget::getMetrics ( unsigned int & width,

unsigned int & height,

unsigned int & colourDepth

) [virtual, inherited]

Retrieve information about the render target.

virtual const String& Ogre::RenderTarget::getName ( void ) const [virtual, inherited]

Retrieve target's name.

virtual unsigned short Ogre::RenderTarget::getNumViewports ( void ) const [virtual, inherited]

Returns the number of viewports attached to this target.

virtual uchar Ogre::RenderTarget::getPriority ( ) const [virtual, inherited]

Gets the priority of a render target.

Definition at line 239 of file OgreRenderTarget.h.
References Ogre::uchar.

virtual const FrameStats& Ogre::RenderTarget::getStatistics ( void ) const [virtual, inherited]

virtual void Ogre::RenderTarget::getStatistics ( float & lastFPS,

float & avgFPS,

float & bestFPS,

float & worstFPS

) const [virtual, inherited]

Retieves details of current rendering performance.

Remarks:
If the user application wishes to do it's own performance display, or use performance for some other means, this method allows it to retrieve the statistics.

Parameters:

lastFPS Pointer to a float to receive the number of frames per second (FPS) based on the last frame rendered.

avgFPS Pointer to a float to receive the FPS rating based on an average of all the frames rendered since rendering began (the call to Root::startRendering).

bestFPS Pointer to a float to receive the best FPS rating that has been achieved since rendering began.

worstFPS Pointer to a float to receive the worst FPS rating seen so far.

virtual size_t Ogre::RenderTarget::getTriangleCount ( void ) const [virtual, inherited]

Gets the number of triangles rendered in the last update() call.

virtual Viewport* Ogre::RenderTarget::getViewport ( unsigned short index ) [virtual, inherited]

Retrieves a pointer to the viewport with the given index.

virtual unsigned int Ogre::RenderTarget::getWidth ( void ) const [virtual, inherited]

virtual float Ogre::RenderTarget::getWorstFPS ( ) const [virtual, inherited]

Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getWorstFrameTime ( ) const [virtual, inherited]

Individual stats access - gets the worst frame time.

virtual bool Ogre::RenderTarget::isActive ( ) const [virtual, inherited]

Used to retrieve or set the active state of the render target.

Reimplemented in Ogre::RenderWindow, Ogre::GLXWindow, Ogre::GTKWindow, and Ogre::SDLWindow.

virtual bool Ogre::RenderTarget::isAutoUpdated ( void ) const [virtual, inherited]

Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

virtual bool Ogre::RenderTarget::isPrimary ( void ) const [virtual, inherited]

Indicates whether this target is the primary window.
The primary window is special in that it is destroyed when ogre is shut down, and cannot be destroyed directly. This is the case because it holds the context for vertex, index buffers and textures.
Reimplemented in Ogre::RenderWindow.

virtual void Ogre::RenderTarget::removeAllListeners ( void ) [virtual, inherited]

Removes all listeners from this instance.

virtual void Ogre::RenderTarget::removeAllViewports ( void ) [virtual, inherited]

Removes all viewports on this target.

virtual void Ogre::RenderTarget::removeListener ( RenderTargetListener * listener ) [virtual, inherited]

Removes a RenderTargetListener previously registered using addListener.

virtual void Ogre::RenderTarget::removeViewport ( int ZOrder ) [virtual, inherited]

Removes a viewport at a given ZOrder.

virtual bool Ogre::RenderTarget::requiresTextureFlipping ( ) const [pure virtual, inherited]

Implemented in Ogre::D3D9MultiRenderTarget, Ogre::D3D9RenderWindow, Ogre::D3D9RenderTexture, Ogre::GLXWindow, Ogre::GTKWindow, Ogre::GLFBOMultiRenderTarget, Ogre::GLRenderTexture, Ogre::SDLWindow, and Ogre::Win32Window.

virtual void Ogre::RenderTarget::resetStatistics ( void ) [virtual, inherited]

Resets saved frame-rate statistices.

virtual void Ogre::RenderTarget::setActive ( bool state ) [virtual, inherited]

Used to set the active state of the render target.

virtual void Ogre::RenderTarget::setAutoUpdated ( bool autoupdate ) [virtual, inherited]

Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

Remarks:
By default, if you use Ogre's own rendering loop (Root::startRendering) or call Root::_updateAllRenderTargets, all render targets are updated automatically. This method allows you to control that behaviour, if for example you have a render target which you only want to update periodically.

Parameters:

autoupdate If true, the render target is updated during the automatic render loop or when Root::_updateAllRenderTargets is called. If false, the target is only updated when its update() method is called explicitly.

virtual void Ogre::RenderTarget::setDebugText ( const String & text ) [virtual, inherited]

Adds debug text to this window.

virtual void Ogre::RenderTarget::setPriority ( uchar priority ) [virtual, inherited]

Sets the priority of this render target in relation to the others.

Remarks:
This can be used in order to schedule render target updates. Lower priorities will be rendered first. Note that the priority must be set at the time the render target is attached to the render system, changes afterwards will not affect the ordering.

Definition at line 237 of file OgreRenderTarget.h.
References Ogre::uchar.

virtual void Ogre::RenderTarget::update ( void ) [virtual, inherited]

Tells the target to update it's contents.

Remarks:
If OGRE is not running in an automatic rendering loop (started using Root::startRendering), the user of the library is responsible for asking each render target to refresh. This is the method used to do this. It automatically re-renders the contents of the target using whatever cameras have been pointed at it (using Camera::setRenderTarget).

This allows OGRE to be used in multi-windowed utilities and for contents to be refreshed only when required, rather than constantly as with the automatic rendering loop.

Reimplemented in Ogre::RenderWindow.

void Ogre::RenderTarget::updateStats ( void ) [protected, inherited]

void Ogre::RenderTexture::writeContentsToFile ( const String & filename ) [virtual]

Writes the current contents of the render target to the named file.

Implements Ogre::RenderTarget.

virtual String Ogre::RenderTarget::writeContentsToTimestampedFile ( const String & filenamePrefix,

const String & filenameSuffix

) [virtual, inherited]

Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.

Returns:
the name of the file used.

Member Data Documentation

bool Ogre::RenderTarget::mActive [protected, inherited]

Reimplemented in Ogre::SDLWindow.
Definition at line 330 of file OgreRenderTarget.h.

bool Ogre::RenderTarget::mAutoUpdate [protected, inherited]

Definition at line 331 of file OgreRenderTarget.h.

HardwarePixelBuffer* Ogre::RenderTexture::mBuffer [protected]

Definition at line 47 of file OgreRenderTexture.h.

unsigned int Ogre::RenderTarget::mColourDepth [protected, inherited]

Definition at line 318 of file OgreRenderTarget.h.

String Ogre::RenderTarget::mDebugText [protected, inherited]

Definition at line 325 of file OgreRenderTarget.h.

size_t Ogre::RenderTarget::mFrameCount [protected, inherited]

Definition at line 328 of file OgreRenderTarget.h.

unsigned int Ogre::RenderTarget::mHeight [protected, inherited]

Definition at line 317 of file OgreRenderTarget.h.

bool Ogre::RenderTarget::mIsDepthBuffered [protected, inherited]

Definition at line 319 of file OgreRenderTarget.h.

unsigned long Ogre::RenderTarget::mLastSecond [protected, inherited]

Definition at line 326 of file OgreRenderTarget.h.

unsigned long Ogre::RenderTarget::mLastTime [protected, inherited]

Definition at line 327 of file OgreRenderTarget.h.

RenderTargetListenerList Ogre::RenderTarget::mListeners [protected, inherited]

Definition at line 340 of file OgreRenderTarget.h.

String Ogre::RenderTarget::mName [protected, inherited]

The name of this target.

Definition at line 312 of file OgreRenderTarget.h.

uchar Ogre::RenderTarget::mPriority [protected, inherited]

The priority of the render target.

Definition at line 314 of file OgreRenderTarget.h.

FrameStats Ogre::RenderTarget::mStats [protected, inherited]

Definition at line 322 of file OgreRenderTarget.h.

Timer* Ogre::RenderTarget::mTimer [protected, inherited]

Definition at line 324 of file OgreRenderTarget.h.

ViewportList Ogre::RenderTarget::mViewportList [protected, inherited]

List of viewports, map on Z-order.

Definition at line 337 of file OgreRenderTarget.h.

unsigned int Ogre::RenderTarget::mWidth [protected, inherited]

Definition at line 316 of file OgreRenderTarget.h.

size_t Ogre::RenderTexture::mZOffset [protected]

Definition at line 48 of file OgreRenderTexture.h.

The documentation for this class was generated from the following file:

OgreRenderTexture.h

Ogre::RenderTexture Class Reference

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes