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

Ogre::D3D9RenderWindow Class Reference

#include <OgreD3D9RenderWindow.h>

Inheritance diagram for Ogre::D3D9RenderWindow:

Inheritance graph
[legend]
Collaboration diagram for Ogre::D3D9RenderWindow:

Collaboration 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

 D3D9RenderWindow ()
 ~D3D9RenderWindow ()
void create (const String &name, unsigned int width, unsigned int height, unsigned int colourDepth, bool fullScreen, int left, int top, bool depthBuffer, void *miscParam,...)
 Creates & displays the new window.

void destroy (void)
 Destroys the window.

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

bool isClosed () const
 Indicates whether the window has been closed by the user.

void reposition (int left, int top)
 Reposition the window.

void resize (unsigned int width, unsigned int height)
 Alter the size of the window.

void swapBuffers (bool waitForVSync=true)
 Swaps the frame buffers to display the next frame.

HWND getWindowHandle () const
HWND getParentWindowHandle () const
D3D9DrivergetDirectD3DDriver ()
LPDIRECT3DDEVICE9 getD3DDevice ()
void outputText (int x, int ty, const String &text)
 DEPRECATED Outputs text to the target at the specified co-ordinates.

void getCustomAttribute (const String &name, void *pData)
 Gets a custom (maybe platform-specific) attribute.

void writeContentsToFile (const String &filename)
 Overridden - see RenderTarget.

bool requiresTextureFlipping () const
virtual void WindowMovedOrResized (void)
void SetExternalWindowHandle (HWND externalHandle)
bool isReady () const
void setReady (bool set)
void setActive (bool set)
 Used to retrieve the active state of the render target.

virtual void update (void)
 Updates the window contents.

virtual bool isFullScreen (void) const
 Returns true if window is running in fullscreen mode.

virtual void getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth, int &left, int &top)
 Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.

virtual void getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
 Retrieve information about the render target.

virtual const StringgetName (void) const
 Retrieve target's name.

virtual unsigned int getWidth (void) const
virtual unsigned int getHeight (void) const
virtual unsigned int getColourDepth (void) const
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 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.


Protected Types

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

Protected Methods

bool _checkMultiSampleQuality (D3DMULTISAMPLE_TYPE type, DWORD *outQuality, D3DFORMAT format, UINT adapterNum, D3DDEVTYPE deviceType, BOOL fullScreen)
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


Static Protected Methods

LRESULT CALLBACK WndProc (HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam)

Protected Attributes

HWND mExternalHandle
HWND mHWnd
HWND mParentHWnd
bool mActive
bool mReady
bool mClosed
D3D9DrivermpD3DDriver
LPDIRECT3DDEVICE9 mpD3DDevice
D3DPRESENT_PARAMETERS md3dpp
LPDIRECT3DSURFACE9 mpRenderSurface
LPDIRECT3DSURFACE9 mpRenderZBuffer
bool mIsFullScreen
int mLeft
int mTop
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
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 307 of file OgreRenderTarget.h.

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

Definition at line 303 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::D3D9RenderWindow::D3D9RenderWindow  
 

Definition at line 143 of file OgreD3D9RenderWindow.cpp.

References mActive, mClosed, mExternalHandle, mHWnd, Ogre::RenderWindow::mIsFullScreen, mpD3DDevice, mpD3DDriver, and mReady.

Ogre::D3D9RenderWindow::~D3D9RenderWindow  
 

Definition at line 155 of file OgreD3D9RenderWindow.cpp.

References mpD3DDevice, mpRenderSurface, mpRenderZBuffer, and SAFE_RELEASE.


Member Function Documentation

bool Ogre::D3D9RenderWindow::_checkMultiSampleQuality D3DMULTISAMPLE_TYPE    type,
DWORD *    outQuality,
D3DFORMAT    format,
UINT    adapterNum,
D3DDEVTYPE    deviceType,
BOOL    fullScreen
[protected]
 

Definition at line 162 of file OgreD3D9RenderWindow.cpp.

References Ogre::D3D9Driver::getD3D(), and mpD3DDriver.

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 286 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 122 of file OgreRenderTarget.cpp.

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

void Ogre::D3D9RenderWindow::create const String   name,
unsigned int    width,
unsigned int    height,
unsigned int    colourDepth,
bool    fullScreen,
int    left,
int    top,
bool    depthBuffer,
void *    miscParam,
...   
[virtual]
 

Creates & displays the new window.

Parameters:
width  The width of the window in pixels.
height  The height of the window in pixels.
colourDepth  The colour depth in bits. Ignored if fullScreen is false since the desktop depth is used.
fullScreen  If true, the window fills the screen, with no title bar or border.
left  The x-position of the window. Ignored if fullScreen = true.
top  The y-position of the window. Ignored if fullScreen = true.
depthBuffer  Specify true to include a depth-buffer.
miscParam  A variable number of pointers to platform-specific arguments. The actual requirements must be defined by the implementing subclasses.

Implements Ogre::RenderWindow.

Definition at line 175 of file OgreD3D9RenderWindow.cpp.

References destroy(), Except, Ogre::D3D9Driver::getAdapterNumber(), Ogre::D3D9Driver::getD3D(), getWindowHandle(), Ogre::LML_NORMAL, Ogre::RenderTarget::mColourDepth, md3dpp, mExternalHandle, Ogre::RenderTarget::mHeight, mHWnd, Ogre::RenderTarget::mIsDepthBuffered, Ogre::RenderWindow::mIsFullScreen, Ogre::RenderWindow::mLeft, Ogre::RenderTarget::mName, mParentHWnd, mpD3DDevice, mpD3DDriver, mpRenderSurface, mpRenderZBuffer, mReady, Ogre::RenderWindow::mTop, Ogre::RenderTarget::mWidth, and WndProc().

void Ogre::D3D9RenderWindow::destroy void    [virtual]
 

Destroys the window.

Implements Ogre::RenderWindow.

Definition at line 392 of file OgreD3D9RenderWindow.cpp.

References mHWnd, mpD3DDevice, mpRenderSurface, mpRenderZBuffer, and SAFE_RELEASE.

Referenced by create().

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

internal method for firing events

Reimplemented in Ogre::RenderTexture.

Definition at line 326 of file OgreRenderTarget.cpp.

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

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

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

internal method for firing events

Definition at line 310 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 380 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 366 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 195 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 199 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 213 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 89 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mColourDepth.

void Ogre::D3D9RenderWindow::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 428 of file OgreD3D9RenderWindow.cpp.

References getD3DDevice(), getWindowHandle(), mpRenderSurface, and mpRenderZBuffer.

LPDIRECT3DDEVICE9 Ogre::D3D9RenderWindow::getD3DDevice void   
 

Definition at line 53 of file OgreD3D9RenderWindow.h.

References mpD3DDevice.

Referenced by getCustomAttribute().

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

Returns the debug text.

Definition at line 281 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mDebugText.

D3D9Driver* Ogre::D3D9RenderWindow::getDirectD3DDriver  
 

Definition at line 52 of file OgreD3D9RenderWindow.h.

References mpD3DDriver.

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

Definition at line 85 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mHeight.

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

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 191 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 74 of file OgreRenderTarget.cpp.

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

void Ogre::RenderWindow::getMetrics unsigned int &    width,
unsigned int &    height,
unsigned int &    colourDepth,
int &    left,
int &    top
[virtual, inherited]
 

Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.

Definition at line 41 of file OgreRenderWindow.cpp.

References Ogre::RenderTarget::mColourDepth, Ogre::RenderTarget::mHeight, Ogre::RenderWindow::mLeft, Ogre::RenderWindow::mTop, and Ogre::RenderTarget::mWidth.

Referenced by Ogre::SDLInput::initialise(), and Ogre::Font::StrBBox().

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

Retrieve target's name.

Definition at line 68 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mName.

Referenced by Ogre::RenderSystem::attachRenderTarget(), Ogre::Root::detachRenderTarget(), 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 340 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mViewportList.

HWND Ogre::D3D9RenderWindow::getParentWindowHandle void    const
 

Definition at line 50 of file OgreD3D9RenderWindow.h.

References mParentHWnd.

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 186 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 173 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 208 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 346 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mViewportList.

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

Definition at line 81 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mWidth.

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

HWND Ogre::D3D9RenderWindow::getWindowHandle void    const
 

Definition at line 49 of file OgreD3D9RenderWindow.h.

References mHWnd.

Referenced by create(), getCustomAttribute(), and Ogre::D3D9RenderSystem::ResizeRepositionWindow().

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 203 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 218 of file OgreRenderTarget.cpp.

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

bool Ogre::D3D9RenderWindow::isActive   const [virtual]
 

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

Reimplemented from Ogre::RenderTarget.

Definition at line 44 of file OgreD3D9RenderWindow.h.

References mActive.

bool Ogre::D3D9RenderWindow::isClosed   const [virtual]
 

Indicates whether the window has been closed by the user.

Implements Ogre::RenderWindow.

Definition at line 45 of file OgreD3D9RenderWindow.h.

References mClosed.

bool Ogre::RenderWindow::isFullScreen void    const [virtual, inherited]
 

Returns true if window is running in fullscreen mode.

Definition at line 51 of file OgreRenderWindow.cpp.

References Ogre::RenderWindow::mIsFullScreen.

bool Ogre::D3D9RenderWindow::isReady   const
 

Definition at line 67 of file OgreD3D9RenderWindow.h.

References mReady.

void Ogre::D3D9RenderWindow::outputText int    x,
int    ty,
const String   text
[virtual]
 

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

Implements Ogre::RenderTarget.

Definition at line 473 of file OgreD3D9RenderWindow.cpp.

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

Removes all listeners from this instance.

Definition at line 305 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mListeners.

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

Removes all viewports on this target.

Definition at line 156 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 291 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 145 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mViewportList.

void Ogre::D3D9RenderWindow::reposition int    left,
int    top
[virtual]
 

Reposition the window.

Implements Ogre::RenderWindow.

Definition at line 46 of file OgreD3D9RenderWindow.h.

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

Implements Ogre::RenderTarget.

Definition at line 60 of file OgreD3D9RenderWindow.h.

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

Resets saved frame-rate statistices.

Definition at line 223 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::D3D9RenderWindow::resize unsigned int    width,
unsigned int    height
[virtual]
 

Alter the size of the window.

Implements Ogre::RenderWindow.

Definition at line 402 of file OgreD3D9RenderWindow.cpp.

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

void Ogre::D3D9RenderWindow::setActive bool    set [virtual]
 

Used to retrieve the active state of the render target.

Reimplemented from Ogre::RenderTarget.

Definition at line 69 of file OgreD3D9RenderWindow.h.

References mActive.

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

Adds debug text to this window.

Definition at line 276 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mDebugText.

void Ogre::D3D9RenderWindow::SetExternalWindowHandle HWND    externalHandle
 

Definition at line 65 of file OgreD3D9RenderWindow.h.

References mExternalHandle.

Referenced by Ogre::D3D9RenderSystem::createRenderWindow().

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::D3D9RenderWindow::setReady bool    set
 

Definition at line 68 of file OgreD3D9RenderWindow.h.

References mReady.

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 168 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mStatFlags.

void Ogre::D3D9RenderWindow::swapBuffers bool    waitForVSync = true [virtual]
 

Swaps the frame buffers to display the next frame.

Remarks:
All render windows 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.
Parameters:
waitForVSync  If true, the system waits for the next vertical blank period (when the CRT beam turns off as it travels from bottom-right to top-left at the end of the pass) before flipping. If false, flipping occurs no matter what the beam position. Waiting for a vertical blank can be slower (and limits the framerate to the monitor refresh rate) but results in a steadier image with no 'tearing' (a flicker resulting from flipping buffers when the beam is in the progress of drawing the last frame).

Implements Ogre::RenderWindow.

Definition at line 414 of file OgreD3D9RenderWindow.cpp.

References Except, and mpD3DDevice.

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

Updates the window contents.

Remarks:
The window is updated by telling each camera which is supposed to render into this window to render it's view, and then the window buffers are swapped via swapBuffers()

Reimplemented from Ogre::RenderTarget.

Definition at line 56 of file OgreRenderWindow.cpp.

References Ogre::RenderWindow::swapBuffers().

Referenced by Ogre::Win32Window::WndProc(), WndProc(), and Ogre::D3D7RenderWindow::WndProc().

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

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

void Ogre::D3D9RenderWindow::WindowMovedOrResized void    [virtual]
 

Definition at line 478 of file OgreD3D9RenderWindow.cpp.

Referenced by Ogre::D3D9RenderSystem::ResizeRepositionWindow(), and WndProc().

LRESULT Ogre::D3D9RenderWindow::WndProc HWND    hWnd,
UINT    uMsg,
WPARAM    wParam,
LPARAM    lParam
[static, protected]
 

Definition at line 43 of file OgreD3D9RenderWindow.cpp.

References Ogre::RenderTarget::getName(), mActive, mClosed, mHWnd, mReady, Ogre::RenderWindow::update(), and WindowMovedOrResized().

Referenced by create().

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

Overridden - see RenderTarget.

Implements Ogre::RenderTarget.

Definition at line 483 of file OgreD3D9RenderWindow.cpp.

References Ogre::Codec::codeToFile(), Except, Ogre::ImageCodec::ImageData::format, Ogre::ImageCodec::ImageData::height, mHWnd, Ogre::RenderWindow::mIsFullScreen, mpD3DDevice, Ogre::PF_R8G8B8, SAFE_RELEASE, Ogre::uchar, Ogre::uint, and Ogre::ImageCodec::ImageData::width.

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 394 of file OgreRenderTarget.cpp.

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


Member Data Documentation

bool Ogre::D3D9RenderWindow::mActive [protected]
 

Reimplemented from Ogre::RenderTarget.

Definition at line 75 of file OgreD3D9RenderWindow.h.

Referenced by D3D9RenderWindow(), isActive(), setActive(), and WndProc().

bool Ogre::D3D9RenderWindow::mClosed [protected]
 

Definition at line 77 of file OgreD3D9RenderWindow.h.

Referenced by D3D9RenderWindow(), isClosed(), and WndProc().

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

Definition at line 286 of file OgreRenderTarget.h.

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

D3DPRESENT_PARAMETERS Ogre::D3D9RenderWindow::md3dpp [protected]
 

Definition at line 94 of file OgreD3D9RenderWindow.h.

Referenced by create().

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

Definition at line 294 of file OgreRenderTarget.h.

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

HWND Ogre::D3D9RenderWindow::mExternalHandle [protected]
 

Definition at line 72 of file OgreD3D9RenderWindow.h.

Referenced by create(), D3D9RenderWindow(), and SetExternalWindowHandle().

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

Definition at line 297 of file OgreRenderTarget.h.

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

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

Definition at line 285 of file OgreRenderTarget.h.

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

HWND Ogre::D3D9RenderWindow::mHWnd [protected]
 

Definition at line 73 of file OgreD3D9RenderWindow.h.

Referenced by create(), D3D9RenderWindow(), destroy(), getWindowHandle(), WndProc(), and writeContentsToFile().

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

Definition at line 287 of file OgreRenderTarget.h.

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

bool Ogre::RenderWindow::mIsFullScreen [protected, inherited]
 

Definition at line 147 of file OgreRenderWindow.h.

Referenced by Ogre::Win32Window::create(), create(), Ogre::D3D7RenderWindow::create(), Ogre::D3D7RenderWindow::D3D7RenderWindow(), D3D9RenderWindow(), Ogre::RenderWindow::isFullScreen(), Ogre::Win32Window::Win32Window(), and writeContentsToFile().

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

Definition at line 295 of file OgreRenderTarget.h.

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

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

Definition at line 296 of file OgreRenderTarget.h.

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

int Ogre::RenderWindow::mLeft [protected, inherited]
 

Definition at line 148 of file OgreRenderWindow.h.

Referenced by Ogre::Win32Window::create(), create(), Ogre::D3D7RenderWindow::create(), and Ogre::RenderWindow::getMetrics().

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

Definition at line 308 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 280 of file OgreRenderTarget.h.

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

HWND Ogre::D3D9RenderWindow::mParentHWnd [protected]
 

Definition at line 74 of file OgreD3D9RenderWindow.h.

Referenced by create(), and getParentWindowHandle().

LPDIRECT3DDEVICE9 Ogre::D3D9RenderWindow::mpD3DDevice [protected]
 

Definition at line 93 of file OgreD3D9RenderWindow.h.

Referenced by create(), D3D9RenderWindow(), destroy(), getD3DDevice(), swapBuffers(), writeContentsToFile(), and ~D3D9RenderWindow().

D3D9Driver* Ogre::D3D9RenderWindow::mpD3DDriver [protected]
 

Definition at line 90 of file OgreD3D9RenderWindow.h.

Referenced by _checkMultiSampleQuality(), create(), D3D9RenderWindow(), and getDirectD3DDriver().

LPDIRECT3DSURFACE9 Ogre::D3D9RenderWindow::mpRenderSurface [protected]
 

Definition at line 95 of file OgreD3D9RenderWindow.h.

Referenced by create(), destroy(), getCustomAttribute(), and ~D3D9RenderWindow().

LPDIRECT3DSURFACE9 Ogre::D3D9RenderWindow::mpRenderZBuffer [protected]
 

Definition at line 96 of file OgreD3D9RenderWindow.h.

Referenced by create(), destroy(), getCustomAttribute(), and ~D3D9RenderWindow().

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

The priority of the render target.

Definition at line 282 of file OgreRenderTarget.h.

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

bool Ogre::D3D9RenderWindow::mReady [protected]
 

Definition at line 76 of file OgreD3D9RenderWindow.h.

Referenced by create(), D3D9RenderWindow(), isReady(), setReady(), and WndProc().

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

Definition at line 290 of file OgreRenderTarget.h.

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

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

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

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

Definition at line 293 of file OgreRenderTarget.h.

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

int Ogre::RenderWindow::mTop [protected, inherited]
 

Definition at line 149 of file OgreRenderWindow.h.

Referenced by Ogre::Win32Window::create(), create(), Ogre::D3D7RenderWindow::create(), and Ogre::RenderWindow::getMetrics().

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

List of viewports, map on Z-order.

Definition at line 305 of file OgreRenderTarget.h.

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

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

Definition at line 284 of file OgreRenderTarget.h.

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


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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:12:19 2004