#include <OgreRenderTexture.h>
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 | |
MultiRenderTarget (const String &name) | |
virtual void | bindSurface (size_t attachment, RenderTexture *target)=0 |
Bind a surface to a certain attachment point. | |
virtual void | unbindSurface (size_t attachment)=0 |
Unbind attachment. | |
virtual void | writeContentsToFile (const String &filename) |
Error throwing implementation, it's not possible to write a MultiRenderTarget to disk. | |
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 | 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 size_t | getBatchCount (void) const |
Gets the number of batches rendered in the last update() call. | |
virtual void | _notifyCameraRemoved (const Camera *cam) |
Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer. | |
virtual bool | isPrimary (void) const |
Indicates whether this target is the primary window. | |
virtual 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 | |
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 |
unsigned long | mLastSecond |
unsigned long | mLastTime |
size_t | mFrameCount |
bool | mActive |
bool | mAutoUpdate |
ViewportList | mViewportList |
List of viewports, map on Z-order. | |
RenderTargetListenerList | mListeners |
Surfaces can be bound and unbound at will, as long as the following constraints are met:
Definition at line 62 of file OgreRenderTexture.h.
typedef std::map<int, Viewport*, std::less<int> > Ogre::RenderTarget::ViewportList [protected, inherited] |
Definition at line 335 of file OgreRenderTarget.h.
typedef std::vector<RenderTargetListener*> Ogre::RenderTarget::RenderTargetListenerList [protected, inherited] |
Definition at line 339 of file OgreRenderTarget.h.
enum Ogre::RenderTarget::StatFlags [inherited] |
Definition at line 62 of file OgreRenderTarget.h.
Ogre::MultiRenderTarget::MultiRenderTarget | ( | const String & | name | ) |
virtual void Ogre::MultiRenderTarget::bindSurface | ( | size_t | attachment, | |
RenderTexture * | target | |||
) | [pure virtual] |
Bind a surface to a certain attachment point.
attachment | 0 .. mCapabilities->numMultiRenderTargets()-1 | |
target | RenderTexture to bind. |
virtual void Ogre::MultiRenderTarget::unbindSurface | ( | size_t | attachment | ) | [pure virtual] |
Unbind attachment.
virtual void Ogre::MultiRenderTarget::writeContentsToFile | ( | const String & | filename | ) | [virtual] |
Error throwing implementation, it's not possible to write a MultiRenderTarget to disk.
Implements Ogre::RenderTarget.
virtual const String& Ogre::RenderTarget::getName | ( | void | ) | const [virtual, inherited] |
Retrieve target's name.
virtual void Ogre::RenderTarget::getMetrics | ( | unsigned int & | width, | |
unsigned int & | height, | |||
unsigned int & | colourDepth | |||
) | [virtual, inherited] |
Retrieve information about the render target.
virtual unsigned int Ogre::RenderTarget::getWidth | ( | void | ) | const [virtual, inherited] |
virtual unsigned int Ogre::RenderTarget::getHeight | ( | void | ) | const [virtual, inherited] |
virtual unsigned int Ogre::RenderTarget::getColourDepth | ( | void | ) | const [virtual, inherited] |
virtual void Ogre::RenderTarget::update | ( | void | ) | [virtual, inherited] |
Tells the target to update it's contents.
Reimplemented in Ogre::RenderWindow.
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.
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 unsigned short Ogre::RenderTarget::getNumViewports | ( | void | ) | const [virtual, inherited] |
Returns the number of viewports attached to this target.
virtual Viewport* Ogre::RenderTarget::getViewport | ( | unsigned short | index | ) | [virtual, inherited] |
Retrieves a pointer to the viewport with the given index.
virtual void Ogre::RenderTarget::removeViewport | ( | int | ZOrder | ) | [virtual, inherited] |
Removes a viewport at a given ZOrder.
virtual void Ogre::RenderTarget::removeAllViewports | ( | void | ) | [virtual, inherited] |
Removes all viewports on this target.
virtual void Ogre::RenderTarget::getStatistics | ( | float & | lastFPS, | |
float & | avgFPS, | |||
float & | bestFPS, | |||
float & | worstFPS | |||
) | const [virtual, inherited] |
Retieves details of current rendering performance.
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 const FrameStats& Ogre::RenderTarget::getStatistics | ( | 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 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::getWorstFPS | ( | ) | const [virtual, inherited] |
Individual stats access - gets the worst 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 float Ogre::RenderTarget::getWorstFrameTime | ( | ) | const [virtual, inherited] |
Individual stats access - gets the worst frame time.
virtual void Ogre::RenderTarget::resetStatistics | ( | void | ) | [virtual, inherited] |
Resets saved frame-rate statistices.
virtual void Ogre::RenderTarget::getCustomAttribute | ( | const String & | name, | |
void * | pData | |||
) | [virtual, inherited] |
Gets a custom (maybe platform-specific) attribute.
name | The name of the attribute. | |
pData | Pointer to memory of the right kind of structure to receive the info. |
virtual void Ogre::RenderTarget::addListener | ( | RenderTargetListener * | listener | ) | [virtual, inherited] |
Add a listener to this RenderTarget which will be called back before & after rendering.
virtual void Ogre::RenderTarget::removeListener | ( | RenderTargetListener * | listener | ) | [virtual, inherited] |
Removes a RenderTargetListener previously registered using addListener.
virtual void Ogre::RenderTarget::removeAllListeners | ( | void | ) | [virtual, inherited] |
Removes all listeners from this instance.
virtual void Ogre::RenderTarget::setPriority | ( | uchar | priority | ) | [virtual, inherited] |
Sets the priority of this render target in relation to the others.
Definition at line 236 of file OgreRenderTarget.h.
virtual uchar Ogre::RenderTarget::getPriority | ( | ) | const [virtual, inherited] |
virtual bool Ogre::RenderTarget::isActive | ( | ) | const [virtual, inherited] |
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.
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 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 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.
virtual bool Ogre::RenderTarget::requiresTextureFlipping | ( | ) | const [pure virtual, inherited] |
virtual size_t Ogre::RenderTarget::getTriangleCount | ( | void | ) | const [virtual, inherited] |
Gets the number of triangles rendered in the last update() call.
virtual size_t Ogre::RenderTarget::getBatchCount | ( | void | ) | const [virtual, inherited] |
Gets the number of batches rendered in the last update() call.
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 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 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.
void Ogre::RenderTarget::updateStats | ( | void | ) | [protected, inherited] |
virtual void Ogre::RenderTarget::firePreUpdate | ( | void | ) | [protected, virtual, inherited] |
internal method for firing events
virtual void Ogre::RenderTarget::firePostUpdate | ( | void | ) | [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::fireViewportPostUpdate | ( | Viewport * | vp | ) | [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::fireViewportRemoved | ( | Viewport * | vp | ) | [protected, virtual, inherited] |
internal method for firing events
String Ogre::RenderTarget::mName [protected, inherited] |
uchar Ogre::RenderTarget::mPriority [protected, inherited] |
unsigned int Ogre::RenderTarget::mWidth [protected, inherited] |
Definition at line 317 of file OgreRenderTarget.h.
unsigned int Ogre::RenderTarget::mHeight [protected, inherited] |
Definition at line 318 of file OgreRenderTarget.h.
unsigned int Ogre::RenderTarget::mColourDepth [protected, inherited] |
Definition at line 319 of file OgreRenderTarget.h.
bool Ogre::RenderTarget::mIsDepthBuffered [protected, inherited] |
Definition at line 320 of file OgreRenderTarget.h.
FrameStats Ogre::RenderTarget::mStats [protected, inherited] |
Definition at line 323 of file OgreRenderTarget.h.
Timer* Ogre::RenderTarget::mTimer [protected, inherited] |
Definition at line 325 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.
size_t Ogre::RenderTarget::mFrameCount [protected, inherited] |
Definition at line 328 of file OgreRenderTarget.h.
bool Ogre::RenderTarget::mActive [protected, inherited] |
Definition at line 330 of file OgreRenderTarget.h.
bool Ogre::RenderTarget::mAutoUpdate [protected, inherited] |
Definition at line 331 of file OgreRenderTarget.h.
ViewportList Ogre::RenderTarget::mViewportList [protected, inherited] |
RenderTargetListenerList Ogre::RenderTarget::mListeners [protected, inherited] |
Definition at line 340 of file OgreRenderTarget.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat May 10 16:28:31 2008