Ogre::MultiRenderTarget Class Referenceabstract
Core » RenderSystem

This class represents a render target that renders to multiple RenderTextures at once. More...

`#include <OgreRenderTexture.h>`

Inheritance diagram for Ogre::MultiRenderTarget:
[legend]

## Public Types

typedef vector< RenderTexture * >::type | BoundSufaceList
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

| MultiRenderTarget (const String &name)
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 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. More...
virtual bool | attachDepthBuffer (DepthBuffer *depthBuffer)
virtual void | bindSurface (size_t attachment, RenderTexture *target)
| Bind a surface to a certain attachment point. More...
virtual void | copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer)
| Error throwing implementation, it's not possible to write a MultiRenderTarget to disk. 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...
RenderTexture * | getBoundSurface (size_t index)
| Get a pointer to a bound surface. More...
const BoundSufaceList & | getBoundSurfaceList () const
| Get a list of the surfaces which have been bound. More...
virtual uint32 | getColourDepth (void) const
virtual void | getCustomAttribute (const String &name, void *pData)
| Gets a custom (maybe platform-specific) attribute. More...
DepthBuffer * | getDepthBuffer () const
uint16 | getDepthBufferPool () const
virtual uint | getFSAA () const
| Indicates whether multisampling is performed on rendering and at what level. More...
virtual const String & | getFSAAHint () 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 String & | getName (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 FrameStats & | getStatistics (void) const
virtual size_t | getTriangleCount (void) const
| Gets the number of triangles rendered in the last update() call. More...
virtual Viewport * | getViewport (unsigned short index)
| Retrieves a pointer to the viewport with the given index. More...
virtual Viewport * | getViewportByZOrder (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...
PixelFormat | suggestPixelFormat () const
| Irrelevant implementation since cannot copy. More...
virtual void | swapBuffers ()
| Swaps the frame buffers to display the next frame. More...
virtual void | unbindSurface (size_t attachment)
| Unbind attachment. 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 | bindSurfaceImpl (size_t attachment, RenderTexture *target)=0
| Implementation of bindSurface, must be provided. More...
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 | unbindSurfaceImpl (size_t attachment)=0
| Implementation of unbindSurface, must be provided. More...
virtual void | updateImpl ()
| Internal implementation of update() More...
void | updateStats (void)

## Protected Attributes

bool | mActive
bool | mAutoUpdate
BoundSufaceList | mBoundSurfaces
uint32 | mColourDepth
DepthBuffer * | mDepthBuffer
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
Timer * | mTimer
ViewportList | mViewportList
| List of viewports, map on Z-order. More...
uint32 | mWidth

## Detailed Description

This class represents a render target that renders to multiple RenderTextures at once.

Surfaces can be bound and unbound at will, as long as the following constraints are met:

- All bound surfaces have the same size
- All bound surfaces have the same bit depth
- Target 0 is bound

Definition at line 69 of file OgreRenderTexture.h.

## Member Typedef Documentation

## BoundSufaceList

typedef vector<RenderTexture*>::type Ogre::MultiRenderTarget::BoundSufaceList

Definition at line 114 of file OgreRenderTexture.h.

## RenderTargetListenerList

typedef vector<RenderTargetListener*>::type Ogre::RenderTarget::RenderTargetListenerList

protected inherited

Definition at line 497 of file OgreRenderTarget.h.

## ViewportList

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

protected inherited

Definition at line 493 of file OgreRenderTarget.h.

## Member Enumeration Documentation

## FrameBuffer

enum Ogre::RenderTarget::FrameBuffer

inherited

Enumerator
FB_FRONT |
FB_BACK |
FB_AUTO |

Definition at line 91 of file OgreRenderTarget.h.

## StatFlags

enum Ogre::RenderTarget::StatFlags

inherited

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

## MultiRenderTarget()

Ogre::MultiRenderTarget::MultiRenderTarget | ( | const String & | name | ) |

## Member Function Documentation

## _beginUpdate()

virtual void Ogre::RenderTarget::_beginUpdate | ( |  | ) |

virtual inherited

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.

## _detachDepthBuffer()

virtual void Ogre::RenderTarget::_detachDepthBuffer | ( |  | ) |

virtual inherited

Detaches DepthBuffer without notifying it from the detach.

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

See also
  DepthBuffer::_setPoolId())

## _endUpdate()

virtual void Ogre::RenderTarget::_endUpdate | ( |  | ) |

virtual inherited

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.

## _getImpl()

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.

## _notifyCameraRemoved()

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.

## _updateAutoUpdatedViewports()

virtual void Ogre::RenderTarget::_updateAutoUpdatedViewports | ( | bool | updateStatistics = `true` | ) |

virtual inherited

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

## _updateViewport() [1/2]

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

virtual inherited

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.

## _updateViewport() [2/2]

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

virtual inherited

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.

## addListener()

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.

## addViewport()

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

## attachDepthBuffer()

virtual bool Ogre::RenderTarget::attachDepthBuffer | ( | DepthBuffer * | depthBuffer | ) |

virtual inherited

## bindSurface()

virtual void Ogre::MultiRenderTarget::bindSurface | ( | size_t | attachment,
|  | RenderTexture * | target
| ) |  |

virtual

Bind a surface to a certain attachment point.

Parameters

  attachment | 0 .. mCapabilities->getNumMultiRenderTargets()-1
  target | RenderTexture to bind.

It does not bind the surface and fails with an exception (ERR_INVALIDPARAMS) if:

- Not all bound surfaces have the same size
- Not all bound surfaces have the same internal format

Definition at line 83 of file OgreRenderTexture.h.

## bindSurfaceImpl()

virtual void Ogre::MultiRenderTarget::bindSurfaceImpl | ( | size_t | attachment,
|  | RenderTexture * | target
| ) |  |

protected pure virtual

Implementation of bindSurface, must be provided.

## copyContentsToMemory()

virtual void Ogre::MultiRenderTarget::copyContentsToMemory | ( | const PixelBox & | dst,
|  | FrameBuffer | buffer
| ) |  |

virtual

Error throwing implementation, it's not possible to write a MultiRenderTarget to disk.

Implements Ogre::RenderTarget.

## detachDepthBuffer()

virtual void Ogre::RenderTarget::detachDepthBuffer | ( |  | ) |

virtual inherited

## firePostUpdate()

virtual void Ogre::RenderTarget::firePostUpdate | ( | void |  | ) |

protected virtual inherited

internal method for firing events

## firePreUpdate()

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

protected virtual inherited

internal method for firing events

## fireViewportAdded()

virtual void Ogre::RenderTarget::fireViewportAdded | ( | Viewport * | vp | ) |

protected virtual inherited

internal method for firing events

## fireViewportPostUpdate()

virtual void Ogre::RenderTarget::fireViewportPostUpdate | ( | Viewport * | vp | ) |

protected virtual inherited

internal method for firing events

## fireViewportPreUpdate()

virtual void Ogre::RenderTarget::fireViewportPreUpdate | ( | Viewport * | vp | ) |

protected virtual inherited

internal method for firing events

## fireViewportRemoved()

virtual void Ogre::RenderTarget::fireViewportRemoved | ( | Viewport * | vp | ) |

protected virtual inherited

internal method for firing events

## getAverageFPS()

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

virtual inherited

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

## getBatchCount()

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

virtual inherited

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

## getBestFPS()

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

virtual inherited

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

## getBestFrameTime()

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

virtual inherited

Individual stats access - gets the best frame time.

## getBoundSurface()

RenderTexture* Ogre::MultiRenderTarget::getBoundSurface | ( | size_t | index | ) |

Get a pointer to a bound surface.

Definition at line 119 of file OgreRenderTexture.h.

## getBoundSurfaceList()

const BoundSufaceList& Ogre::MultiRenderTarget::getBoundSurfaceList | ( |  | ) | const

Get a list of the surfaces which have been bound.

Definition at line 116 of file OgreRenderTexture.h.

## getColourDepth()

virtual uint32 Ogre::RenderTarget::getColourDepth | ( | void |  | ) | const

virtual inherited

## getCustomAttribute()

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.

## getDepthBuffer()

DepthBuffer* Ogre::RenderTarget::getDepthBuffer | ( |  | ) | const

inherited

## getDepthBufferPool()

uint16 Ogre::RenderTarget::getDepthBufferPool | ( |  | ) | const

inherited

## getFSAA()

virtual uint Ogre::RenderTarget::getFSAA | ( |  | ) | const

virtual inherited

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

Definition at line 378 of file OgreRenderTarget.h.

## getFSAAHint()

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

virtual inherited

Gets the FSAA hint (.

See also
  Root::createRenderWindow)

Definition at line 382 of file OgreRenderTarget.h.

## getHeight()

virtual uint32 Ogre::RenderTarget::getHeight | ( | void |  | ) | const

virtual inherited

## getLastFPS()

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.

## getMetrics()

virtual void Ogre::RenderTarget::getMetrics | ( | unsigned int & | width,
|  | unsigned int & | height,
|  | unsigned int & | colourDepth
| ) |  |

virtual inherited

Retrieve information about the render target.

## getName()

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

virtual inherited

Retrieve target's name.

## getNumViewports()

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

virtual inherited

Returns the number of viewports attached to this target.

## getPriority()

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

virtual inherited

Gets the priority of a render target.

Definition at line 302 of file OgreRenderTarget.h.

## getStatistics() [1/2]

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.

## getStatistics() [2/2]

virtual const FrameStats& Ogre::RenderTarget::getStatistics | ( | void |  | ) | const

virtual inherited

## getTriangleCount()

virtual size_t Ogre::RenderTarget::getTriangleCount | ( | void |  | ) | const

virtual inherited

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

## getViewport()

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

virtual inherited

Retrieves a pointer to the viewport with the given index.

## getViewportByZOrder()

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

virtual inherited

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

Remarks
  throws if not found.

## getWidth()

virtual uint32 Ogre::RenderTarget::getWidth | ( | void |  | ) | const

virtual inherited

## getWorstFPS()

virtual float Ogre::RenderTarget::getWorstFPS | ( |  | ) | const

virtual inherited

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

## getWorstFrameTime()

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

virtual inherited

Individual stats access - gets the worst frame time.

## hasViewportWithZOrder()

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

virtual inherited

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

## isActive()

virtual bool Ogre::RenderTarget::isActive | ( |  | ) | const

virtual inherited

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

Reimplemented in Ogre::RenderWindow.

## isAutoUpdated()

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.

## isHardwareGammaEnabled()

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

virtual inherited

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.

## isPrimary()

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.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

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.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

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.

## operator new() [1/3]

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.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

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.

## operator new[]() [1/2]

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.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## removeAllListeners()

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

virtual inherited

Removes all listeners from this instance.

## removeAllViewports()

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

virtual inherited

Removes all viewports on this target.

## removeListener()

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

virtual inherited

Removes a RenderTargetListener previously registered using addListener.

## removeViewport()

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

virtual inherited

Removes a viewport at a given Z-order.

## requiresTextureFlipping()

virtual bool Ogre::RenderTarget::requiresTextureFlipping | ( |  | ) | const

pure virtual inherited

## resetStatistics()

virtual void Ogre::RenderTarget::resetStatistics | ( | void |  | ) |

virtual inherited

Resets saved frame-rate statistices.

## setActive()

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

virtual inherited

Used to set the active state of the render target.

## setAutoUpdated()

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.

## setDepthBufferPool()

void Ogre::RenderTarget::setDepthBufferPool | ( | uint16 | poolId | ) |

inherited

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

## setPriority()

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

## suggestPixelFormat()

PixelFormat Ogre::MultiRenderTarget::suggestPixelFormat | ( |  | ) | const

virtual

Irrelevant implementation since cannot copy.

Reimplemented from Ogre::RenderTarget.

Definition at line 112 of file OgreRenderTexture.h.

References Ogre::PF_UNKNOWN.

## swapBuffers()

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

virtual inherited

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.

Definition at line 167 of file OgreRenderTarget.h.

## unbindSurface()

virtual void Ogre::MultiRenderTarget::unbindSurface | ( | size_t | attachment | ) |

virtual

Unbind attachment.

Definition at line 99 of file OgreRenderTexture.h.

## unbindSurfaceImpl()

virtual void Ogre::MultiRenderTarget::unbindSurfaceImpl | ( | size_t | attachment | ) |

protected pure virtual

Implementation of unbindSurface, must be provided.

## update()

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

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.

Parameters

  swapBuffers

  For 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.

## updateImpl()

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

protected virtual inherited

Internal implementation of update()

## updateStats()

void Ogre::RenderTarget::updateStats | ( | void |  | ) |

protected inherited

## writeContentsToFile()

void Ogre::RenderTarget::writeContentsToFile | ( | const String & | filename | ) |

inherited

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

## writeContentsToTimestampedFile()

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

## mActive

bool Ogre::RenderTarget::mActive

protected inherited

Definition at line 483 of file OgreRenderTarget.h.

## mAutoUpdate

bool Ogre::RenderTarget::mAutoUpdate

protected inherited

Definition at line 484 of file OgreRenderTarget.h.

## mBoundSurfaces

BoundSufaceList Ogre::MultiRenderTarget::mBoundSurfaces

protected

Definition at line 127 of file OgreRenderTexture.h.

## mColourDepth

uint32 Ogre::RenderTarget::mColourDepth

protected inherited

Definition at line 471 of file OgreRenderTarget.h.

## mDepthBuffer

DepthBuffer* Ogre::RenderTarget::mDepthBuffer

protected inherited

Definition at line 473 of file OgreRenderTarget.h.

## mDepthBufferPoolId

uint16 Ogre::RenderTarget::mDepthBufferPoolId

protected inherited

Definition at line 472 of file OgreRenderTarget.h.

## mFrameCount

size_t Ogre::RenderTarget::mFrameCount

protected inherited

Definition at line 481 of file OgreRenderTarget.h.

## mFSAA

uint Ogre::RenderTarget::mFSAA

protected inherited

Definition at line 488 of file OgreRenderTarget.h.

## mFSAAHint

String Ogre::RenderTarget::mFSAAHint

protected inherited

Definition at line 489 of file OgreRenderTarget.h.

## mHeight

uint32 Ogre::RenderTarget::mHeight

protected inherited

Definition at line 470 of file OgreRenderTarget.h.

## mHwGamma

bool Ogre::RenderTarget::mHwGamma

protected inherited

Definition at line 486 of file OgreRenderTarget.h.

## mLastSecond

unsigned long Ogre::RenderTarget::mLastSecond

protected inherited

Definition at line 479 of file OgreRenderTarget.h.

## mLastTime

unsigned long Ogre::RenderTarget::mLastTime

protected inherited

Definition at line 480 of file OgreRenderTarget.h.

## mListeners

RenderTargetListenerList Ogre::RenderTarget::mListeners

protected inherited

Definition at line 498 of file OgreRenderTarget.h.

## mName

String Ogre::RenderTarget::mName

protected inherited

The name of this target.

Definition at line 465 of file OgreRenderTarget.h.

## mPriority

uchar Ogre::RenderTarget::mPriority

protected inherited

The priority of the render target.

Definition at line 467 of file OgreRenderTarget.h.

## mStats

FrameStats Ogre::RenderTarget::mStats

protected inherited

Definition at line 476 of file OgreRenderTarget.h.

## mTimer

Timer* Ogre::RenderTarget::mTimer

protected inherited

Definition at line 478 of file OgreRenderTarget.h.

## mViewportList

ViewportList Ogre::RenderTarget::mViewportList

protected inherited

List of viewports, map on Z-order.

Definition at line 495 of file OgreRenderTarget.h.

## mWidth

uint32 Ogre::RenderTarget::mWidth

protected inherited

Definition at line 469 of file OgreRenderTarget.h.

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

- OgreRenderTexture.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.