OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::MultiRenderTarget Class Referenceabstract

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

#include <OgreRenderTexture.h>

+ Inheritance diagram for Ogre::MultiRenderTarget:

Public Types

typedef std::vector< RenderTexture * > BoundSufaceList
 
- Public Types inherited from Ogre::RenderTarget
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 bindSurface (size_t attachment, RenderTexture *target)
 Bind a surface to a certain attachment point. More...
 
virtual void copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
 Error throwing implementation, it's not possible to write a MultiRenderTarget to disk. More...
 
virtual void copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO)=0
 Copies the current contents of the render target to a pixelbox. More...
 
void copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
RenderTexturegetBoundSurface (size_t index)
 Get a pointer to a bound surface. More...
 
const BoundSufaceListgetBoundSurfaceList () const
 Get a list of the surfaces which have been bound. More...
 
PixelFormat suggestPixelFormat () const
 Irrelevant implementation since cannot copy. More...
 
virtual void unbindSurface (size_t attachment)
 Unbind attachment. More...
 
- Public Member Functions inherited from Ogre::RenderTarget
 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)
 
void copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void detachDepthBuffer ()
 
virtual uint32 getColourDepth (void) const
 
uint getCustomAttribute (const String &name)
 simplified API for bindings More...
 
virtual void getCustomAttribute (const String &name, void *pData)
 Retrieve a platform or API-specific piece of information. 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 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...
 
const FrameStatsgetStatistics (void) const
 Retieves details of current rendering performance. 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 bool hasViewportWithZOrder (int ZOrder)
 Returns true if and only if a viewport exists at the given Z-order. More...
 
virtual void insertListener (RenderTargetListener *listener, const unsigned int pos=0)
 same as addListener, but force the position in the vector, so we can control the call 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...
 
virtual bool isStereoEnabled (void) const
 Indicates whether stereo is currently enabled for this target. More...
 
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
 
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 setFSAA (uint fsaa, const String &fsaaHint)
 Set the level of multisample AA to be used if hardware support it. More...
 
virtual void setPriority (uchar priority)
 Sets the priority of this render target in relation to the others. 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...
 

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

Member Typedef Documentation

◆ BoundSufaceList

Constructor & Destructor Documentation

◆ MultiRenderTarget()

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

Member Function Documentation

◆ bindSurface()

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

Bind a surface to a certain attachment point.

Parameters
attachment0 .. mCapabilities->getNumMultiRenderTargets()-1
targetRenderTexture 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

◆ unbindSurface()

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

Unbind attachment.

◆ copyContentsToMemory() [1/3]

virtual void Ogre::MultiRenderTarget::copyContentsToMemory ( const Box src,
const PixelBox dst,
FrameBuffer  buffer = FB_AUTO 
)
virtual

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

Implements Ogre::RenderTarget.

◆ suggestPixelFormat()

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

Irrelevant implementation since cannot copy.

Reimplemented from Ogre::RenderTarget.

References Ogre::PF_UNKNOWN.

◆ getBoundSurfaceList()

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

Get a list of the surfaces which have been bound.

◆ getBoundSurface()

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

Get a pointer to a bound surface.

◆ copyContentsToMemory() [2/3]

virtual void Ogre::RenderTarget::copyContentsToMemory

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.

◆ copyContentsToMemory() [3/3]

void Ogre::RenderTarget::copyContentsToMemory
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:
This function is deprecated as behavior for dst.size < RenderTarget.size was inconsistent in previous versions of Ogre.

Sometimes the whole rect was used as a source, sometimes the rect with the size equal to the size of destination rect but located in the top left corner of the render target, sometimes the destination rect itself. Use the overload with explicitly specified source and destination boxes instead.


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