Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Ogre::RenderTarget Class Referenceabstract

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

#include <OgreRenderTarget.h>

Inheritance diagram for Ogre::RenderTarget:
Inheritance graph
[legend]

Classes

struct  FrameStats
 
class  Impl
 RenderSystem specific interface for a RenderTarget; this should be subclassed by RenderSystems. More...
 

Public Types

enum  FrameBuffer { FB_FRONT, FB_BACK, FB_AUTO }
 
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

 RenderTarget ()
 
virtual ~RenderTarget ()
 
virtual void _beginUpdate ()
 Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. More...
 
virtual void _detachDepthBuffer ()
 Detaches DepthBuffer without notifying it from the detach. More...
 
virtual void _endUpdate ()
 Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. More...
 
virtual Impl_getImpl ()
 Get rendersystem specific interface for this RenderTarget. More...
 
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. More...

 
virtual void _updateAutoUpdatedViewports (bool updateStatistics=true)
 Method for manual management of rendering - renders only viewports that are auto updated. More...
 
virtual void _updateViewport (int zorder, bool updateStatistics=true)
 
Method for manual management of rendering - renders the given 

viewport (even if it is not autoupdated) More...

 
virtual void _updateViewport (Viewport *viewport, bool updateStatistics=true)
 Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...
 
virtual void addListener (RenderTargetListener *listener)
 Add a listener to this RenderTarget which will be called back before & after rendering. More...
 
virtual ViewportaddViewport (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. More...
 
virtual bool attachDepthBuffer (DepthBuffer *depthBuffer)
 
virtual void copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)=0
 Copies the current contents of the render target to a pixelbox. More...
 
virtual void detachDepthBuffer ()
 
virtual float getAverageFPS () const
 Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering. More...
 
virtual size_t getBatchCount (void) const
 Gets the number of batches rendered in the last update() call. More...
 
virtual float getBestFPS () const
 Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering. More...
 
virtual float getBestFrameTime () const
 Individual stats access - gets the best frame time. More...
 
virtual uint32 getColourDepth (void) const
 
virtual void getCustomAttribute (const String &name, void *pData)
 Gets a custom (maybe platform-specific) attribute. More...
 
DepthBuffergetDepthBuffer () const
 
uint16 getDepthBufferPool () const
 
virtual uint getFSAA () const
 Indicates whether multisampling is performed on rendering and at what level. More...
 
virtual const StringgetFSAAHint () const
 Gets the FSAA hint (. More...
 
virtual uint32 getHeight (void) const
 
virtual float getLastFPS () const
 Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered. More...
 
virtual void getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
 Retrieve information about the render target. More...
 
virtual const StringgetName (void) const
 Retrieve target's name. More...
 
virtual unsigned short getNumViewports (void) const
 Returns the number of viewports attached to this target. More...
 
virtual uchar getPriority () const
 Gets the priority of a render target. More...
 
virtual void getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) const
 Retieves details of current rendering performance. More...
 
virtual const FrameStatsgetStatistics (void) const
 
virtual size_t getTriangleCount (void) const
 Gets the number of triangles rendered in the last update() call. More...
 
virtual ViewportgetViewport (unsigned short index)
 Retrieves a pointer to the viewport with the given index. More...
 
virtual ViewportgetViewportByZOrder (int ZOrder)
 Retrieves a pointer to the viewport with the given Z-order. More...
 
virtual uint32 getWidth (void) const
 
virtual float getWorstFPS () const
 Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering. More...
 
virtual float getWorstFrameTime () const
 Individual stats access - gets the worst frame time. More...
 
virtual bool hasViewportWithZOrder (int ZOrder)
 Returns true if and only if a viewport exists at the given Z-order. More...
 
virtual bool isActive () const
 Used to retrieve or set the active state of the render target. More...
 
virtual bool isAutoUpdated (void) const
 Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
 
virtual bool isHardwareGammaEnabled () const
 Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. More...
 
virtual bool isPrimary (void) const
 Indicates whether this target is the primary window. More...
 
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 *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void removeAllListeners (void)
 Removes all listeners from this instance. More...
 
virtual void removeAllViewports (void)
 Removes all viewports on this target. More...
 
virtual void removeListener (RenderTargetListener *listener)
 Removes a RenderTargetListener previously registered using addListener. More...
 
virtual void removeViewport (int ZOrder)
 Removes a viewport at a given Z-order. More...
 
virtual bool requiresTextureFlipping () const =0
 
virtual void resetStatistics (void)
 Resets saved frame-rate statistices. More...
 
virtual void setActive (bool state)
 Used to set the active state of the render target. More...
 
virtual void setAutoUpdated (bool autoupdate)
 Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
 
void setDepthBufferPool (uint16 poolId)
 Sets the pool ID this RenderTarget should query from. More...
 
virtual void setPriority (uchar priority)
 Sets the priority of this render target in relation to the others. More...
 
virtual PixelFormat suggestPixelFormat () const
 Suggests a pixel format to use for extracting the data in this target, when calling copyContentsToMemory. More...
 
virtual void swapBuffers ()
 Swaps the frame buffers to display the next frame. More...
 
virtual void update (bool swapBuffers=true)
 Tells the target to update it's contents. More...
 
void writeContentsToFile (const String &filename)
 Writes the current contents of the render target to the named file. More...
 
virtual String writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
 Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. More...
 

Protected Types

typedef vector
< RenderTargetListener * >
::type 
RenderTargetListenerList
 
typedef map< int, Viewport * >
::type 
ViewportList
 

Protected Member Functions

virtual void firePostUpdate (void)
 internal method for firing events More...
 
virtual void firePreUpdate (void)
 internal method for firing events More...
 
virtual void fireViewportAdded (Viewport *vp)
 internal method for firing events More...
 
virtual void fireViewportPostUpdate (Viewport *vp)
 internal method for firing events More...
 
virtual void fireViewportPreUpdate (Viewport *vp)
 internal method for firing events More...
 
virtual void fireViewportRemoved (Viewport *vp)
 internal method for firing events More...
 
virtual void updateImpl ()
 Internal implementation of update() More...
 
void updateStats (void)
 

Protected Attributes

bool mActive
 
bool mAutoUpdate
 
uint32 mColourDepth
 
DepthBuffermDepthBuffer
 
uint16 mDepthBufferPoolId
 
size_t mFrameCount
 
uint mFSAA
 
String mFSAAHint
 
uint32 mHeight
 
bool mHwGamma
 
unsigned long mLastSecond
 
unsigned long mLastTime
 
RenderTargetListenerList mListeners
 
String mName
 The name of this target. More...
 
uchar mPriority
 The priority of the render target. More...
 
FrameStats mStats
 
TimermTimer
 
ViewportList mViewportList
 List of viewports, map on Z-order. More...
 
uint32 mWidth
 

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 65 of file OgreRenderTarget.h.

Member Typedef Documentation

Definition at line 497 of file OgreRenderTarget.h.

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

Definition at line 493 of file OgreRenderTarget.h.

Member Enumeration Documentation

Enumerator
FB_FRONT 
FB_BACK 
FB_AUTO 

Definition at line 91 of file OgreRenderTarget.h.

Enumerator
SF_NONE 
SF_FPS 
SF_AVG_FPS 
SF_BEST_FPS 
SF_WORST_FPS 
SF_TRIANGLE_COUNT 
SF_ALL 

Definition at line 68 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();
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.

Reimplemented in Ogre::D3D9RenderWindow, Ogre::EAGLWindow, and Ogre::EAGL2Window.

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())

Reimplemented in Ogre::GLFBORenderTexture, Ogre::GL3PlusFBORenderTexture, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GLESFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

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.

Reimplemented in Ogre::D3D9RenderWindow.

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
updateStatisticsWhether you want to update statistics or not.
See Also
_beginUpdate()
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
zorderThe zorder of the viewport to update.
updateStatisticsWhether you want to update statistics or not.
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
viewportThe viewport you want to update, it must be bound to the rendertarget.
updateStatisticsWhether you want to update statistics or not.

Reimplemented in Ogre::D3D9RenderWindow.

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
camThe camera from which the viewport contents will be rendered (mandatory)
ZOrderThe relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher Z-orders are on top of lower ones. The actual number is irrelevant, only the relative Z-order matters (you can leave gaps in the numbering)
leftThe relative position of the left of the viewport on the target, as a value between 0 and 1.
topThe relative position of the top of the viewport on the target, as a value between 0 and 1.
widthThe relative width of the viewport on the target, as a value between 0 and 1.
heightThe 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::MultiRenderTarget, Ogre::EAGLWindow, Ogre::EAGL2Window, Ogre::GLXWindow, Ogre::GLXWindow, Ogre::EGLWindow, Ogre::EGLWindow, Ogre::GTKWindow, Ogre::GTKWindow, Ogre::D3D9RenderWindow, Ogre::SDLWindow, Ogre::SDLWindow, Ogre::NaClWindow, Ogre::D3D11RenderWindowBase, Ogre::OSXWindow, Ogre::Win32Window, Ogre::Win32Window, and Ogre::RenderTexture.

virtual void Ogre::RenderTarget::detachDepthBuffer ( )
virtual
virtual void Ogre::RenderTarget::firePostUpdate ( void  )
protectedvirtual

internal method for firing events

virtual void Ogre::RenderTarget::firePreUpdate ( void  )
protectedvirtual

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportAdded ( Viewport vp)
protectedvirtual

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPostUpdate ( Viewport vp)
protectedvirtual

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPreUpdate ( Viewport vp)
protectedvirtual

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportRemoved ( Viewport vp)
protectedvirtual

internal method for firing events

virtual float Ogre::RenderTarget::getAverageFPS ( ) const
virtual

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

virtual size_t Ogre::RenderTarget::getBatchCount ( void  ) const
virtual

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

virtual float Ogre::RenderTarget::getBestFPS ( ) const
virtual

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

virtual float Ogre::RenderTarget::getBestFrameTime ( ) const
virtual

Individual stats access - gets the best frame time.

virtual uint32 Ogre::RenderTarget::getColourDepth ( void  ) const
virtual
virtual void Ogre::RenderTarget::getCustomAttribute ( const String name,
void *  pData 
)
virtual
DepthBuffer* Ogre::RenderTarget::getDepthBuffer ( ) const
uint16 Ogre::RenderTarget::getDepthBufferPool ( ) const
virtual uint Ogre::RenderTarget::getFSAA ( ) const
virtual

Indicates whether multisampling is performed on rendering and at what level.

Definition at line 378 of file OgreRenderTarget.h.

virtual const String& Ogre::RenderTarget::getFSAAHint ( ) const
virtual

Gets the FSAA hint (.

See Also
Root::createRenderWindow)

Definition at line 382 of file OgreRenderTarget.h.

virtual uint32 Ogre::RenderTarget::getHeight ( void  ) const
virtual
virtual float Ogre::RenderTarget::getLastFPS ( ) const
virtual

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

Retrieve information about the render target.

virtual const String& Ogre::RenderTarget::getName ( void  ) const
virtual

Retrieve target's name.

virtual unsigned short Ogre::RenderTarget::getNumViewports ( void  ) const
virtual

Returns the number of viewports attached to this target.

virtual uchar Ogre::RenderTarget::getPriority ( ) const
virtual

Gets the priority of a render target.

Definition at line 302 of file OgreRenderTarget.h.

virtual void Ogre::RenderTarget::getStatistics ( float &  lastFPS,
float &  avgFPS,
float &  bestFPS,
float &  worstFPS 
) const
virtual

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
lastFPSPointer to a float to receive the number of frames per second (FPS) based on the last frame rendered.
avgFPSPointer 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).
bestFPSPointer to a float to receive the best FPS rating that has been achieved since rendering began.
worstFPSPointer to a float to receive the worst FPS rating seen so far.
virtual const FrameStats& Ogre::RenderTarget::getStatistics ( void  ) const
virtual
virtual size_t Ogre::RenderTarget::getTriangleCount ( void  ) const
virtual

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

virtual Viewport* Ogre::RenderTarget::getViewport ( unsigned short  index)
virtual

Retrieves a pointer to the viewport with the given index.

virtual Viewport* Ogre::RenderTarget::getViewportByZOrder ( int  ZOrder)
virtual

Retrieves a pointer to the viewport with the given Z-order.

Remarks
throws if not found.
virtual uint32 Ogre::RenderTarget::getWidth ( void  ) const
virtual
virtual float Ogre::RenderTarget::getWorstFPS ( ) const
virtual

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

virtual float Ogre::RenderTarget::getWorstFrameTime ( ) const
virtual

Individual stats access - gets the worst frame time.

virtual bool Ogre::RenderTarget::hasViewportWithZOrder ( int  ZOrder)
virtual

Returns true if and only if a viewport exists at the given Z-order.

virtual bool Ogre::RenderTarget::isActive ( ) const
virtual
virtual bool Ogre::RenderTarget::isAutoUpdated ( void  ) const
virtual

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

virtual bool Ogre::RenderTarget::isHardwareGammaEnabled ( ) const
virtual

Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space.

This is the exact opposite conversion of what is indicated by Texture::isHardwareGammaEnabled, and can only be enabled on creation of the render target. For render windows, it's enabled through the 'gamma' creation misc parameter. For textures, it is enabled through the hwGamma parameter to the create call.

Definition at line 374 of file OgreRenderTarget.h.

virtual bool Ogre::RenderTarget::isPrimary ( void  ) const
virtual

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.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::RenderTarget::removeAllListeners ( void  )
virtual

Removes all listeners from this instance.

virtual void Ogre::RenderTarget::removeAllViewports ( void  )
virtual

Removes all viewports on this target.

virtual void Ogre::RenderTarget::removeListener ( RenderTargetListener listener)
virtual

Removes a RenderTargetListener previously registered using addListener.

virtual void Ogre::RenderTarget::removeViewport ( int  ZOrder)
virtual

Removes a viewport at a given Z-order.

virtual bool Ogre::RenderTarget::requiresTextureFlipping ( ) const
pure virtual
virtual void Ogre::RenderTarget::resetStatistics ( void  )
virtual

Resets saved frame-rate statistices.

virtual void Ogre::RenderTarget::setActive ( bool  state)
virtual

Used to set the active state of the render target.

Reimplemented in Ogre::D3D11RenderWindowHwnd, Ogre::Win32Window, and Ogre::Win32Window.

virtual void Ogre::RenderTarget::setAutoUpdated ( bool  autoupdate)
virtual

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
autoupdateIf 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.
void Ogre::RenderTarget::setDepthBufferPool ( uint16  poolId)

Sets the pool ID this RenderTarget should query from.

Default value is POOL_DEFAULT. Set to POOL_NO_DEPTH to avoid using a DepthBuffer (or manually controlling it)

See Also
DepthBuffer
Remarks
Changing the pool Id will cause the current depth buffer to be detached unless the old id and the new one are the same
virtual void Ogre::RenderTarget::setPriority ( uchar  priority)
virtual

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 300 of file OgreRenderTarget.h.

virtual PixelFormat Ogre::RenderTarget::suggestPixelFormat ( ) const
virtual

Suggests a pixel format to use for extracting the data in this target, when calling copyContentsToMemory.

Reimplemented in Ogre::RenderWindow, Ogre::MultiRenderTarget, Ogre::EAGL2Window, and Ogre::RenderTexture.

Definition at line 339 of file OgreRenderTarget.h.

References Ogre::PF_BYTE_RGBA.

virtual void Ogre::RenderTarget::swapBuffers ( void  )
virtual

Swaps the frame buffers to display the next frame.

Remarks
For targets that are double-buffered so that no 'in-progress' versions of the scene are displayed during rendering. Once rendering has completed (to an off-screen version of the window) the buffers are swapped to display the new frame.

Reimplemented in Ogre::D3D9RenderTexture, Ogre::D3D11RenderWindowImageSource, Ogre::D3D11RenderWindowSwapChainBased, Ogre::EAGLWindow, Ogre::EAGL2Window, Ogre::GLXWindow, Ogre::GLXWindow, Ogre::EGLWindow, Ogre::EGLWindow, Ogre::GTKWindow, Ogre::GTKWindow, Ogre::OSXCarbonWindow, Ogre::NaClWindow, Ogre::SDLWindow, Ogre::SDLWindow, Ogre::D3D9RenderWindow, Ogre::OSXWindow, Ogre::Win32Window, Ogre::Win32Window, Ogre::GLFBORenderTexture, and Ogre::GL3PlusFBORenderTexture.

Definition at line 167 of file OgreRenderTarget.h.

virtual void Ogre::RenderTarget::update ( bool  swapBuffers = true)
virtual

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.
Parameters
swapBuffersFor targets that support double-buffering, if set to true, the target will immediately swap it's buffers after update. Otherwise, the buffers are not swapped, and you have to call swapBuffers yourself sometime later. You might want to do this on some rendersystems which pause for queued rendering commands to complete before accepting swap buffers calls - so you could do other CPU tasks whilst the queued commands complete. Or, you might do this if you want custom control over your windows, such as for externally created windows.

Reimplemented in Ogre::D3D9RenderTexture, Ogre::D3D11RenderWindowImageSource, and Ogre::D3D9MultiRenderTarget.

virtual void Ogre::RenderTarget::updateImpl ( )
protectedvirtual

Internal implementation of update()

void Ogre::RenderTarget::updateStats ( void  )
protected
void Ogre::RenderTarget::writeContentsToFile ( const String filename)

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

virtual String Ogre::RenderTarget::writeContentsToTimestampedFile ( const String filenamePrefix,
const String filenameSuffix 
)
virtual

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

Definition at line 483 of file OgreRenderTarget.h.

bool Ogre::RenderTarget::mAutoUpdate
protected

Definition at line 484 of file OgreRenderTarget.h.

uint32 Ogre::RenderTarget::mColourDepth
protected

Definition at line 471 of file OgreRenderTarget.h.

DepthBuffer* Ogre::RenderTarget::mDepthBuffer
protected

Definition at line 473 of file OgreRenderTarget.h.

uint16 Ogre::RenderTarget::mDepthBufferPoolId
protected

Definition at line 472 of file OgreRenderTarget.h.

size_t Ogre::RenderTarget::mFrameCount
protected

Definition at line 481 of file OgreRenderTarget.h.

uint Ogre::RenderTarget::mFSAA
protected

Definition at line 488 of file OgreRenderTarget.h.

String Ogre::RenderTarget::mFSAAHint
protected

Definition at line 489 of file OgreRenderTarget.h.

uint32 Ogre::RenderTarget::mHeight
protected

Definition at line 470 of file OgreRenderTarget.h.

bool Ogre::RenderTarget::mHwGamma
protected

Definition at line 486 of file OgreRenderTarget.h.

unsigned long Ogre::RenderTarget::mLastSecond
protected

Definition at line 479 of file OgreRenderTarget.h.

unsigned long Ogre::RenderTarget::mLastTime
protected

Definition at line 480 of file OgreRenderTarget.h.

RenderTargetListenerList Ogre::RenderTarget::mListeners
protected

Definition at line 498 of file OgreRenderTarget.h.

String Ogre::RenderTarget::mName
protected

The name of this target.

Definition at line 465 of file OgreRenderTarget.h.

uchar Ogre::RenderTarget::mPriority
protected

The priority of the render target.

Definition at line 467 of file OgreRenderTarget.h.

FrameStats Ogre::RenderTarget::mStats
protected

Definition at line 476 of file OgreRenderTarget.h.

Timer* Ogre::RenderTarget::mTimer
protected

Definition at line 478 of file OgreRenderTarget.h.

ViewportList Ogre::RenderTarget::mViewportList
protected

List of viewports, map on Z-order.

Definition at line 495 of file OgreRenderTarget.h.

uint32 Ogre::RenderTarget::mWidth
protected

Definition at line 469 of file OgreRenderTarget.h.


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

Copyright © 2013 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sat Dec 14 2013 14:36:39