Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::D3D9RenderTexture Class Reference

#include <OgreD3D9Texture.h>

Inheritance diagram for Ogre::D3D9RenderTexture:

Inheritance graph
[legend]
List of all members.

Public Types

enum  StatFlags {
  SF_NONE = 0, SF_FPS = 1, SF_AVG_FPS = 2, SF_BEST_FPS = 4,
  SF_WORST_FPS = 8, SF_TRIANGLE_COUNT = 16, SF_ALL = 0xFFFF
}

Public Methods

 D3D9RenderTexture (const String &name, uint width, uint height, TextureType texType=TEX_TYPE_2D)
 ~D3D9RenderTexture ()
virtual void getCustomAttribute (const String &name, void *pData)
 Gets a custom (maybe platform-specific) attribute.

bool requiresTextureFlipping () const
virtual void writeContentsToFile (const String &filename)
 Writes the current contents of the render target to the named file.

virtual void outputText (int x, int y, const String &text)
 DEPRECATED Outputs text to the target at the specified co-ordinates.

virtual const StringgetName (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 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.

virtual unsigned short getNumViewports (void) const
 Returns the number of viewports attached to this target.

virtual ViewportgetViewport (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 setStatsDisplay (StatFlags sf)
 DEPRECATED Set what kind of statistics display (if any) should be displayed by the system about 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 setDebugText (const String &text)
 Adds debug text to this window.

const StringgetDebugText () const
 Returns the debug text.

virtual void addListener (RenderTargetListener *listener)
 Add a listener to this RenderTarget which will be called back before & after rendering.

virtual void removeListener (RenderTargetListener *listener)
 Removes a RenderTargetListener previously registered using addListener.

virtual void removeAllListeners (void)
 Removes all listeners from this instance.

virtual void setPriority (uchar priority)
 Sets the priority of this render target in relation to the others.

virtual uchar getPriority () const
 Gets the priority of a render target.

virtual bool isActive () const
 Used to retrieve or set the active state of the render target.

virtual void setActive (bool state)
 Used to set the active state of the render target.

virtual void setAutoUpdated (bool autoupdate)
 Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

virtual bool isAutoUpdated (void) const
 Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

virtual String writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
 Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.

virtual size_t getTriangleCount (void) const
 Gets the number of triangles rendered in the last update() call.

virtual void _notifyCameraRemoved (const Camera *cam)
 Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.


Protected Types

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

Protected Methods

virtual void _copyToTexture ()
virtual void firePostUpdate ()
 internal method for firing events

void updateStats (void)
virtual void firePreUpdate (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


Protected Attributes

TexturemPrivateTex
 The texture to which rendering takes place.

TexturemTexture
 The texture that gets accesses by the rest of the API.

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
StatFlags mStatFlags
FrameStats mStats
TimermTimer
String mDebugText
unsigned long mLastSecond
unsigned long mLastTime
size_t mFrameCount
bool mActive
bool mAutoUpdate
ViewportList mViewportList
 List of viewports, map on Z-order.

RenderTargetListenerList mListeners

Member Typedef Documentation

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

Definition at line 329 of file OgreRenderTarget.h.

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

Definition at line 325 of file OgreRenderTarget.h.


Member Enumeration Documentation

enum Ogre::RenderTarget::StatFlags [inherited]
 

Enumeration values:
SF_NONE 
SF_FPS 
SF_AVG_FPS 
SF_BEST_FPS 
SF_WORST_FPS 
SF_TRIANGLE_COUNT 
SF_ALL 

Definition at line 58 of file OgreRenderTarget.h.


Constructor & Destructor Documentation

Ogre::D3D9RenderTexture::D3D9RenderTexture const String   name,
uint    width,
uint    height,
TextureType    texType = TEX_TYPE_2D
 

Definition at line 167 of file OgreD3D9Texture.h.

References Ogre::RenderTarget::mHeight, Ogre::RenderTarget::mName, mPrivateTex, Ogre::RenderTarget::mWidth, Ogre::PF_R8G8B8, Ogre::TEX_TYPE_2D, Ogre::TextureType, Ogre::TU_RENDERTARGET, and Ogre::uint.

Ogre::D3D9RenderTexture::~D3D9RenderTexture  
 

Definition at line 172 of file OgreD3D9Texture.h.

References mPrivateTex, and SAFE_DELETE.


Member Function Documentation

virtual void Ogre::D3D9RenderTexture::_copyToTexture void    [protected, virtual]
 

Implements Ogre::RenderTexture.

Definition at line 239 of file OgreD3D9Texture.h.

References Ogre::Texture::copyToTexture(), and Ogre::RenderTexture::mTexture.

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.

Definition at line 414 of file OgreRenderTarget.cpp.

References Ogre::Viewport::getCamera(), Ogre::RenderTarget::mViewportList, and Ogre::Viewport::setCamera().

Referenced by Ogre::RenderSystem::_notifyCameraRemoved().

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.

Definition at line 287 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mListeners.

Viewport * Ogre::RenderTarget::addViewport Camera   cam,
int    ZOrder = 0,
float    left = 0.0f,
float    top = 0.0f,
float    width = 1.0f,
float    height = 1.0f
[virtual, inherited]
 

Adds a viewport to the rendering target.

Remarks:
A viewport is the rectangle into which redering output is sent. This method adds a viewport to the render target, rendering from the supplied camera. The rest of the parameters are only required if you wish to add more than one viewport to a single rendering target. Note that size information passed to this method is passed as a parametric, i.e. it is relative rather than absolute. This is to allow viewports to automatically resize along with the target.
Parameters:
cam  The camera from which the viewport contents will be rendered (mandatory)
ZOrder  The relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher ZOrders are on top of lower ones. The actual number is irrelevant, only the relative ZOrder matters (you can leave gaps in the numbering)
left  The relative position of the left of the viewport on the target, as a value between 0 and 1.
top  The relative position of the top of the viewport on the target, as a value between 0 and 1.
width  The relative width of the viewport on the target, as a value between 0 and 1.
height  The relative height of the viewport on the target, as a value between 0 and 1.

Definition at line 123 of file OgreRenderTarget.cpp.

References Except, and Ogre::RenderTarget::mViewportList.

Referenced by Ogre::SceneManager::createShadowTextures().

void Ogre::RenderTexture::firePostUpdate   [protected, virtual, inherited]
 

internal method for firing events

Reimplemented from Ogre::RenderTarget.

Definition at line 57 of file OgreRenderTexture.cpp.

References Ogre::RenderTexture::_copyToTexture().

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

internal method for firing events

Definition at line 311 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mListeners, and Ogre::RenderTargetEvent::source.

Referenced by Ogre::RenderTarget::update().

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

internal method for firing events

Definition at line 381 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mListeners, and Ogre::RenderTargetViewportEvent::source.

Referenced by Ogre::RenderTarget::update().

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

internal method for firing events

Definition at line 367 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mListeners, and Ogre::RenderTargetViewportEvent::source.

Referenced by Ogre::RenderTarget::update().

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

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

Definition at line 196 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::FrameStats::avgFPS, and Ogre::RenderTarget::mStats.

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

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

Definition at line 200 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::FrameStats::bestFPS, and Ogre::RenderTarget::mStats.

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

Individual stats access - gets the best frame time.

Definition at line 214 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::FrameStats::bestFrameTime, and Ogre::RenderTarget::mStats.

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

Definition at line 90 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mColourDepth.

virtual void Ogre::D3D9RenderTexture::getCustomAttribute const String   name,
void *    pData
[virtual]
 

Gets a custom (maybe platform-specific) attribute.

Remarks:
This is a nasty way of satisfying any API's need to see platform-specific details. It horrid, but D3D needs this kind of info. At least it's abstracted.
Parameters:
name  The name of the attribute.
pData  Pointer to memory of the right kind of structure to receive the info.

Reimplemented from Ogre::RenderTarget.

Definition at line 177 of file OgreD3D9Texture.h.

References Except, mPrivateTex, Ogre::TEX_TYPE_2D, and Ogre::TEX_TYPE_CUBE_MAP.

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

Returns the debug text.

Definition at line 282 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mDebugText.

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

Definition at line 86 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mHeight.

Referenced by Ogre::GLRenderSystem::_setViewport(), Ogre::Viewport::_updateDimensions(), and Ogre::GLRenderSystem::setScissorTest().

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

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

Definition at line 192 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::FrameStats::lastFPS, and Ogre::RenderTarget::mStats.

void Ogre::RenderTarget::getMetrics unsigned int &    width,
unsigned int &    height,
unsigned int &    colourDepth
[virtual, inherited]
 

Retrieve information about the render target.

Definition at line 75 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mColourDepth, Ogre::RenderTarget::mHeight, and Ogre::RenderTarget::mWidth.

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

Retrieve target's name.

Definition at line 69 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mName.

Referenced by Ogre::RenderSystem::attachRenderTarget(), Ogre::SceneManager::createShadowTextures(), Ogre::Root::detachRenderTarget(), Ogre::SceneManager::renderModulativeTextureShadowedQueueGroupObjects(), Ogre::D3D9RenderWindow::WndProc(), and Ogre::D3D7RenderWindow::WndProc().

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

Returns the number of viewports attached to this target.

Definition at line 341 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mViewportList.

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

Gets the priority of a render target.

Definition at line 256 of file OgreRenderTarget.h.

References Ogre::uchar.

Referenced by Ogre::RenderSystem::attachRenderTarget().

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

Definition at line 187 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mStats.

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.

Definition at line 174 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::FrameStats::avgFPS, Ogre::RenderTarget::FrameStats::bestFPS, Ogre::RenderTarget::FrameStats::lastFPS, Ogre::RenderTarget::mStats, and Ogre::RenderTarget::FrameStats::worstFPS.

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

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

Definition at line 209 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mStats, and Ogre::RenderTarget::FrameStats::triangleCount.

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

Retrieves a pointer to the viewport with the given index.

Definition at line 347 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mViewportList.

Referenced by Ogre::SceneManager::createShadowTextures(), Ogre::SceneManager::prepareShadowTextures(), and Ogre::SceneManager::renderModulativeTextureShadowedQueueGroupObjects().

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

Definition at line 82 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mWidth.

Referenced by Ogre::Viewport::_updateDimensions().

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

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

Definition at line 204 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mStats, and Ogre::RenderTarget::FrameStats::worstFPS.

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

Individual stats access - gets the worst frame time.

Definition at line 219 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mStats, and Ogre::RenderTarget::FrameStats::worstFrameTime.

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

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

Reimplemented in Ogre::D3D7RenderWindow, Ogre::D3D9RenderWindow, Ogre::GTKWindow, Ogre::SDLWindow, and Ogre::Win32Window.

Definition at line 357 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mActive.

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.

Definition at line 434 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mAutoUpdate.

virtual void Ogre::D3D9RenderTexture::outputText int    x,
int    y,
const String   text
[virtual]
 

DEPRECATED Outputs text to the target at the specified co-ordinates.

Implements Ogre::RenderTarget.

Definition at line 233 of file OgreD3D9Texture.h.

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

Removes all listeners from this instance.

Definition at line 306 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mListeners.

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

Removes all viewports on this target.

Definition at line 157 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mViewportList.

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

Removes a RenderTargetListener previously registered using addListener.

Definition at line 292 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mListeners.

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

Removes a viewport at a given ZOrder.

Definition at line 146 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mViewportList.

bool Ogre::D3D9RenderTexture::requiresTextureFlipping   const [virtual]
 

Implements Ogre::RenderTarget.

Definition at line 231 of file OgreD3D9Texture.h.

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

Resets saved frame-rate statistices.

Definition at line 224 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::FrameStats::avgFPS, Ogre::RenderTarget::FrameStats::bestFPS, Ogre::RenderTarget::FrameStats::bestFrameTime, Ogre::Timer::getMilliseconds(), Ogre::RenderTarget::FrameStats::lastFPS, Ogre::RenderTarget::mFrameCount, Ogre::RenderTarget::mLastSecond, Ogre::RenderTarget::mLastTime, Ogre::RenderTarget::mStats, Ogre::RenderTarget::mTimer, Ogre::RenderTarget::FrameStats::triangleCount, Ogre::RenderTarget::FrameStats::worstFPS, and Ogre::RenderTarget::FrameStats::worstFrameTime.

Referenced by Ogre::RenderTarget::RenderTarget().

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

Used to set the active state of the render target.

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

Definition at line 362 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mActive.

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.

Definition at line 429 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mAutoUpdate.

Referenced by Ogre::SceneManager::createShadowTextures().

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

Adds debug text to this window.

Definition at line 277 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mDebugText.

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

References Ogre::uchar.

void Ogre::RenderTarget::setStatsDisplay StatFlags    sf [virtual, inherited]
 

DEPRECATED Set what kind of statistics display (if any) should be displayed by the system about this target.

Remarks:
This method is now DEPRECATED. Use Root::showDebugOverlay instead. OGRE keeps details about the current rendering performance, and can display this on screen if required. This method allows you to specify what should be displayed. Alternatively, the application can retrieve the stats using RenderTarget::getStatistics and report them itself.
Parameters:
sf  Flags indicating which stats to display. Details are in StatFlags

Definition at line 169 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mStatFlags.

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

Tells the target to update it's contents.

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

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

Reimplemented in Ogre::RenderWindow.

Definition at line 95 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::firePostUpdate(), Ogre::RenderTarget::firePreUpdate(), Ogre::RenderTarget::fireViewportPostUpdate(), Ogre::RenderTarget::fireViewportPreUpdate(), Ogre::RenderTarget::mStats, Ogre::RenderTarget::mViewportList, Ogre::RenderTarget::FrameStats::triangleCount, and Ogre::RenderTarget::updateStats().

Referenced by Ogre::SceneManager::prepareShadowTextures().

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

Definition at line 239 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::FrameStats::avgFPS, Ogre::RenderTarget::FrameStats::bestFPS, Ogre::RenderTarget::FrameStats::bestFrameTime, Ogre::Timer::getMilliseconds(), Ogre::RenderTarget::FrameStats::lastFPS, Ogre::RenderTarget::mFrameCount, Ogre::RenderTarget::mLastSecond, Ogre::RenderTarget::mLastTime, Ogre::RenderTarget::mStats, Ogre::RenderTarget::mTimer, Ogre::RenderTarget::FrameStats::worstFPS, and Ogre::RenderTarget::FrameStats::worstFrameTime.

Referenced by Ogre::RenderTarget::update().

virtual void Ogre::D3D9RenderTexture::writeContentsToFile const String   filename [virtual]
 

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

Implements Ogre::RenderTarget.

Definition at line 232 of file OgreD3D9Texture.h.

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.

Definition at line 395 of file OgreRenderTarget.cpp.

References Ogre::Timer::getMilliseconds(), Ogre::RenderTarget::mTimer, and Ogre::RenderTarget::writeContentsToFile().


Member Data Documentation

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

Reimplemented in Ogre::D3D7RenderWindow, Ogre::D3D9RenderWindow, Ogre::SDLWindow, and Ogre::Win32Window.

Definition at line 320 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::isActive(), Ogre::RenderTarget::RenderTarget(), and Ogre::RenderTarget::setActive().

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

Definition at line 321 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::isAutoUpdated(), Ogre::RenderTarget::RenderTarget(), and Ogre::RenderTarget::setAutoUpdated().

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

Definition at line 307 of file OgreRenderTarget.h.

Referenced by Ogre::Win32Window::create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), Ogre::D3D7RenderWindow::createDDSurfaces(), Ogre::D3D7RenderWindow::createDepthBuffer(), Ogre::RenderTarget::getColourDepth(), Ogre::RenderWindow::getMetrics(), and Ogre::RenderTarget::getMetrics().

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

Definition at line 315 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::getDebugText(), and Ogre::RenderTarget::setDebugText().

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

Definition at line 318 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::resetStatistics(), and Ogre::RenderTarget::updateStats().

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

Definition at line 306 of file OgreRenderTarget.h.

Referenced by Ogre::GLRenderTexture::_copyToTexture(), Ogre::Win32Window::create(), Ogre::SDLWindow::create(), Ogre::GTKWindow::create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), Ogre::D3D7RenderWindow::createDDSurfaces(), Ogre::D3D7RenderTexture::D3D7RenderTexture(), D3D9RenderTexture(), Ogre::RenderTarget::getHeight(), Ogre::RenderWindow::getMetrics(), Ogre::RenderTarget::getMetrics(), Ogre::GTKWindow::GTKWindow(), Ogre::RenderTexture::RenderTexture(), Ogre::Win32Window::resize(), Ogre::D3D9RenderWindow::resize(), Ogre::D3D7RenderWindow::resize(), Ogre::Win32Window::writeContentsToFile(), and Ogre::SDLWindow::writeContentsToFile().

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

Definition at line 308 of file OgreRenderTarget.h.

Referenced by Ogre::Win32Window::create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), and Ogre::D3D7RenderWindow::createDepthBuffer().

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

Definition at line 316 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::resetStatistics(), and Ogre::RenderTarget::updateStats().

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

Definition at line 317 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::resetStatistics(), and Ogre::RenderTarget::updateStats().

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

Definition at line 330 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::addListener(), Ogre::RenderTarget::firePostUpdate(), Ogre::RenderTarget::firePreUpdate(), Ogre::RenderTarget::fireViewportPostUpdate(), Ogre::RenderTarget::fireViewportPreUpdate(), Ogre::RenderTarget::removeAllListeners(), and Ogre::RenderTarget::removeListener().

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

The name of this target.

Definition at line 301 of file OgreRenderTarget.h.

Referenced by Ogre::Win32Window::create(), Ogre::SDLWindow::create(), Ogre::GTKWindow::create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), Ogre::D3D7RenderTexture::D3D7RenderTexture(), D3D9RenderTexture(), Ogre::RenderTarget::getName(), Ogre::RenderTexture::RenderTexture(), Ogre::RenderTarget::~RenderTarget(), and Ogre::RenderTexture::~RenderTexture().

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

The priority of the render target.

Definition at line 303 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::RenderTarget(), and Ogre::RenderTexture::RenderTexture().

Texture* Ogre::D3D9RenderTexture::mPrivateTex [protected]
 

The texture to which rendering takes place.

Definition at line 237 of file OgreD3D9Texture.h.

Referenced by D3D9RenderTexture(), getCustomAttribute(), and ~D3D9RenderTexture().

StatFlags Ogre::RenderTarget::mStatFlags [protected, inherited]
 

Definition at line 311 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::RenderTarget(), and Ogre::RenderTarget::setStatsDisplay().

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

Definition at line 312 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::getAverageFPS(), Ogre::RenderTarget::getBestFPS(), Ogre::RenderTarget::getBestFrameTime(), Ogre::RenderTarget::getLastFPS(), Ogre::RenderTarget::getStatistics(), Ogre::RenderTarget::getTriangleCount(), Ogre::RenderTarget::getWorstFPS(), Ogre::RenderTarget::getWorstFrameTime(), Ogre::RenderTarget::resetStatistics(), Ogre::RenderTarget::update(), Ogre::RenderTarget::updateStats(), and Ogre::RenderTarget::~RenderTarget().

Texture* Ogre::RenderTexture::mTexture [protected, inherited]
 

The texture that gets accesses by the rest of the API.

Definition at line 47 of file OgreRenderTexture.h.

Referenced by Ogre::GLRenderTexture::_copyToTexture(), _copyToTexture(), Ogre::D3D7RenderTexture::_copyToTexture(), Ogre::RenderTexture::RenderTexture(), and Ogre::RenderTexture::~RenderTexture().

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

Definition at line 314 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::RenderTarget(), Ogre::RenderTarget::resetStatistics(), Ogre::RenderTarget::updateStats(), and Ogre::RenderTarget::writeContentsToTimestampedFile().

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

List of viewports, map on Z-order.

Definition at line 327 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::_notifyCameraRemoved(), Ogre::RenderTarget::addViewport(), Ogre::RenderTarget::getNumViewports(), Ogre::RenderTarget::getViewport(), Ogre::RenderTarget::removeAllViewports(), Ogre::RenderTarget::removeViewport(), Ogre::Win32Window::resize(), Ogre::SDLWindow::resize(), Ogre::D3D9RenderWindow::resize(), Ogre::D3D7RenderWindow::resize(), Ogre::RenderTarget::update(), Ogre::D3D7RenderWindow::windowMovedOrResized(), and Ogre::RenderTarget::~RenderTarget().

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

Definition at line 305 of file OgreRenderTarget.h.

Referenced by Ogre::GLRenderTexture::_copyToTexture(), Ogre::Win32Window::create(), Ogre::SDLWindow::create(), Ogre::GTKWindow::create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), Ogre::D3D7RenderWindow::createDDSurfaces(), Ogre::D3D7RenderTexture::D3D7RenderTexture(), D3D9RenderTexture(), Ogre::RenderWindow::getMetrics(), Ogre::RenderTarget::getMetrics(), Ogre::RenderTarget::getWidth(), Ogre::GTKWindow::GTKWindow(), Ogre::RenderTexture::RenderTexture(), Ogre::Win32Window::resize(), Ogre::D3D9RenderWindow::resize(), Ogre::D3D7RenderWindow::resize(), Ogre::Win32Window::writeContentsToFile(), and Ogre::SDLWindow::writeContentsToFile().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:23:54 2004