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

# Ogre::Win32Window Class Reference

`#include <OgreWin32Window.h>`

Inheritance diagram for Ogre::Win32Window:

[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

| Win32Window ()
| ~Win32Window ()
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 (void) const
| Used to retrieve or set the active state of the render target.
bool | isClosed (void) 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)
| Swaps the frame buffers to display the next frame.
void | writeContentsToFile (const String &filename)
| Overridden - see RenderTarget.
bool | requiresTextureFlipping () const
HWND | getWindowHandle () const
virtual void | windowMovedOrResized (void)
void | setExternalWindowHandle (HWND externalHandle)
bool | isReady () const
void | setReady (bool set)
void | setActive (bool set)
| Used to set 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 String & | getName (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 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 | 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 | getCustomAttribute (const String &name, void *pData)
| Gets a custom (maybe platform-specific) attribute.
virtual void | setDebugText (const String &text)
| Adds debug text to this window.
const String & | getDebugText () 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 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

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
HDC | mHDC
HGLRC | mGlrc
int | mOldSwapIntervall
bool | mActive
bool | mReady
bool | mClosed
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
Timer * | mTimer
String | mDebugText
unsigned long | mLastSecond
unsigned long | mLastTime
size_t | mFrameCount
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 325 of file OgreRenderTarget.h.

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

| Definition at line 321 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::Win32Window::Win32Window | ( |  | ) |

| Definition at line 35 of file OgreWin32Window.cpp. References mActive, mClosed, mExternalHandle, mHWnd, Ogre::RenderWindow::mIsFullScreen, and mReady.

Ogre::Win32Window::~Win32Window | ( |  | ) |

| Definition at line 45 of file OgreWin32Window.cpp. References destroy().

## Member Function Documentation

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::Win32Window::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 50 of file OgreWin32Window.cpp.

References destroy(), Except, getWindowHandle(), Ogre::LML_CRITICAL, Ogre::LML_NORMAL, Ogre::LoadIcon(), Ogre::RenderTarget::mColourDepth, mExternalHandle, mGlrc, mHDC, Ogre::RenderTarget::mHeight, mHWnd, Ogre::RenderTarget::mIsDepthBuffered, Ogre::RenderWindow::mIsFullScreen, Ogre::RenderWindow::mLeft, Ogre::RenderTarget::mName, mOldSwapIntervall, mReady, Ogre::RenderWindow::mTop, Ogre::RenderTarget::mWidth, Ogre::String, and WndProc().

Referenced by Ogre::Win32GLSupport::newWindow().

void Ogre::Win32Window::destroy | ( | void |  | ) | `[virtual]`

| Destroys the window. Implements Ogre::RenderWindow. Definition at line 224 of file OgreWin32Window.cpp. References mActive, mGlrc, mHDC, mHWnd, and mOldSwapIntervall. Referenced by create(), and ~Win32Window().

void Ogre::RenderTarget::firePostUpdate | ( | void |  | ) | `[protected, virtual, inherited]`

| internal method for firing events Reimplemented in Ogre::RenderTexture. Definition at line 327 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 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. Referenced by Ogre::D3D9RenderSystem::initialise(), and Ogre::D3DRenderSystem::initialise().

void Ogre::RenderTarget::getCustomAttribute | ( | const String & | name,
|  | void * | pData
| ) | `[virtual, inherited]`

Gets a custom (maybe platform-specific) attribute.

Remarks:
  This is a nasty way of satisfying any API's need to see platform-specific details. It horrid, but D3D needs this kind of info. At least it's abstracted.

Parameters:

  name | The name of the attribute.
  pData | Pointer to memory of the right kind of structure to receive the info.

Reimplemented in Ogre::D3D7RenderWindow, Ogre::D3D7RenderTexture, Ogre::D3D9RenderWindow, Ogre::D3D9RenderTexture, Ogre::GTKWindow, and Ogre::GLXWindow.

Definition at line 272 of file OgreRenderTarget.cpp.

References Except, and Ogre::String.

Referenced by Ogre::D3D9RenderSystem::_setViewport(), Ogre::D3DRenderSystem::_setViewport(), Ogre::D3D9RenderSystem::createRenderWindow(), Ogre::D3DRenderSystem::createRenderWindow(), and Ogre::GLXInput::initialise().

const String & Ogre::RenderTarget::getDebugText | ( |  | ) | const`[inherited]`

| Returns the debug text. Definition at line 282 of file OgreRenderTarget.cpp. References Ogre::RenderTarget::mDebugText, and Ogre::String.

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.

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::GLXInput::capture(), Ogre::GLXInput::GrabCursor(), Ogre::SDLInput::initialise(), Ogre::GLXInput::initialise(), and Ogre::Font::StrBBox().

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, and Ogre::String. Referenced by Ogre::RenderSystem::attachRenderTarget(), Ogre::SceneManager::createShadowTextures(), Ogre::Root::detachRenderTarget(), and Ogre::SceneManager::renderModulativeTextureShadowedQueueGroupObjects().

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

HWND Ogre::Win32Window::getWindowHandle | ( | void |  | ) | const

| Definition at line 55 of file OgreWin32Window.h. References mHWnd. Referenced by create(), Ogre::Win32GLSupport::resizeReposition(), and windowMovedOrResized().

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::Win32Window::isActive | ( | void |  | ) | const`[virtual]`

| Used to retrieve or set the active state of the render target. Reimplemented from Ogre::RenderTarget. Definition at line 244 of file OgreWin32Window.cpp. References 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.

bool Ogre::Win32Window::isClosed | ( | void |  | ) | const`[virtual]`

| Indicates whether the window has been closed by the user. Implements Ogre::RenderWindow. Definition at line 249 of file OgreWin32Window.cpp. 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::Win32Window::isReady | ( |  | ) | const

| Definition at line 62 of file OgreWin32Window.h. References mReady.

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.

void Ogre::Win32Window::reposition | ( | int | left,
|  | int | top
| ) | `[virtual]`

| Reposition the window. Implements Ogre::RenderWindow. Definition at line 254 of file OgreWin32Window.cpp.

bool Ogre::Win32Window::requiresTextureFlipping | ( |  | ) | const`[virtual]`

| Implements Ogre::RenderTarget. Definition at line 53 of file OgreWin32Window.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::Win32Window::resize | ( | unsigned int | width,
|  | unsigned int | height
| ) | `[virtual]`

| Alter the size of the window. Implements Ogre::RenderWindow. Definition at line 259 of file OgreWin32Window.cpp. References Ogre::RenderTarget::mHeight, Ogre::RenderTarget::mViewportList, and Ogre::RenderTarget::mWidth. Referenced by windowMovedOrResized().

void Ogre::Win32Window::setActive | ( | bool | set | ) | `[virtual]`

| Used to set the active state of the render target. Reimplemented from Ogre::RenderTarget. Definition at line 64 of file OgreWin32Window.h. References 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, and Ogre::String.

void Ogre::Win32Window::setExternalWindowHandle | ( | HWND | externalHandle | ) |

| Definition at line 60 of file OgreWin32Window.h. References mExternalHandle. Referenced by Ogre::Win32GLSupport::newWindow().

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

References Ogre::uchar.

void Ogre::Win32Window::setReady | ( | bool | set | ) |

| Definition at line 63 of file OgreWin32Window.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 169 of file OgreRenderTarget.cpp.

References Ogre::RenderTarget::mStatFlags.

void Ogre::Win32Window::swapBuffers | ( | bool | waitForVSync | ) | `[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 281 of file OgreWin32Window.cpp.

References mHDC.

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::GTKWindow::on_expose_event(), WndProc(), Ogre::D3D9RenderWindow::WndProc(), and Ogre::D3D7RenderWindow::WndProc().

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

void Ogre::Win32Window::windowMovedOrResized | ( | void |  | ) | `[virtual]`

| Definition at line 273 of file OgreWin32Window.cpp. References getWindowHandle(), and resize(). Referenced by Ogre::Win32GLSupport::resizeReposition(), and WndProc().

LRESULT Ogre::Win32Window::WndProc | ( | HWND | hWnd,
|  | UINT | uMsg,
|  | WPARAM | wParam,
|  | LPARAM | lParam
| ) | `[static, protected]`

| Definition at line 334 of file OgreWin32Window.cpp. References mActive, mClosed, mHWnd, mReady, Ogre::RenderWindow::update(), and windowMovedOrResized(). Referenced by create().

void Ogre::Win32Window::writeContentsToFile | ( | const String & | filename | ) | `[virtual]`

Overridden - see RenderTarget.

Implements Ogre::RenderTarget.

Definition at line 286 of file OgreWin32Window.cpp.

References Ogre::Codec::codeToFile(), Except, Ogre::Image::flipAroundX(), Ogre::ImageCodec::ImageData::format, Ogre::Image::getData(), Ogre::DataChunk::getSize(), Ogre::ImageCodec::ImageData::height, Ogre::Image::loadRawData(), Ogre::RenderTarget::mHeight, Ogre::RenderTarget::mWidth, Ogre::PF_R8G8B8, Ogre::String, Ogre::uchar, 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 395 of file OgreRenderTarget.cpp.

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

## Member Data Documentation

bool Ogre::Win32Window::mActive`[protected]`

| Reimplemented from Ogre::RenderTarget. Definition at line 71 of file OgreWin32Window.h. Referenced by destroy(), isActive(), setActive(), Win32Window(), and WndProc().

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

| Definition at line 317 of file OgreRenderTarget.h. Referenced by Ogre::RenderTarget::isAutoUpdated(), Ogre::RenderTarget::RenderTarget(), and Ogre::RenderTarget::setAutoUpdated().

bool Ogre::Win32Window::mClosed`[protected]`

| Definition at line 73 of file OgreWin32Window.h. Referenced by isClosed(), Win32Window(), and WndProc().

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

| Definition at line 303 of file OgreRenderTarget.h. Referenced by 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 311 of file OgreRenderTarget.h. Referenced by Ogre::RenderTarget::getDebugText(), and Ogre::RenderTarget::setDebugText().

HWND Ogre::Win32Window::mExternalHandle`[protected]`

| Definition at line 66 of file OgreWin32Window.h. Referenced by create(), setExternalWindowHandle(), and Win32Window().

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

| Definition at line 314 of file OgreRenderTarget.h. Referenced by Ogre::RenderTarget::resetStatistics(), and Ogre::RenderTarget::updateStats().

HGLRC Ogre::Win32Window::mGlrc`[protected]`

| Definition at line 69 of file OgreWin32Window.h. Referenced by create(), and destroy().

HDC Ogre::Win32Window::mHDC`[protected]`

| Definition at line 68 of file OgreWin32Window.h. Referenced by create(), destroy(), and swapBuffers().

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

Definition at line 302 of file OgreRenderTarget.h.

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

HWND Ogre::Win32Window::mHWnd`[protected]`

| Definition at line 67 of file OgreWin32Window.h. Referenced by create(), destroy(), getWindowHandle(), Win32Window(), and WndProc().

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

| Definition at line 304 of file OgreRenderTarget.h. Referenced by create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), and Ogre::D3D7RenderWindow::createDepthBuffer().

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

| Definition at line 147 of file OgreRenderWindow.h. Referenced by create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), Ogre::D3D7RenderWindow::D3D7RenderWindow(), Ogre::D3D9RenderWindow::D3D9RenderWindow(), Ogre::RenderWindow::isFullScreen(), Win32Window(), and Ogre::D3D9RenderWindow::writeContentsToFile().

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

| Definition at line 312 of file OgreRenderTarget.h. Referenced by Ogre::RenderTarget::resetStatistics(), and Ogre::RenderTarget::updateStats().

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

| Definition at line 313 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 create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), and Ogre::RenderWindow::getMetrics().

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

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

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

int Ogre::Win32Window::mOldSwapIntervall`[protected]`

| Definition at line 70 of file OgreWin32Window.h. Referenced by create(), and destroy().

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

| The priority of the render target. Definition at line 299 of file OgreRenderTarget.h. Referenced by Ogre::RenderTarget::RenderTarget(), and Ogre::RenderTexture::RenderTexture().

bool Ogre::Win32Window::mReady`[protected]`

| Definition at line 72 of file OgreWin32Window.h. Referenced by create(), isReady(), setReady(), Win32Window(), and WndProc().

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

| Definition at line 307 of file OgreRenderTarget.h. Referenced by Ogre::RenderTarget::RenderTarget(), and Ogre::RenderTarget::setStatsDisplay().

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

Definition at line 308 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 310 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 create(), Ogre::D3D9RenderWindow::create(), Ogre::D3D7RenderWindow::create(), and Ogre::RenderWindow::getMetrics().

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

List of viewports, map on Z-order.

Definition at line 323 of file OgreRenderTarget.h.

Referenced by Ogre::RenderTarget::_notifyCameraRemoved(), Ogre::RenderTarget::addViewport(), Ogre::RenderTarget::getNumViewports(), Ogre::RenderTarget::getViewport(), Ogre::GLXWindow::processEvent(), Ogre::RenderTarget::removeAllViewports(), Ogre::RenderTarget::removeViewport(), 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 301 of file OgreRenderTarget.h.

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

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

- OgreWin32Window.h
- OgreWin32Window.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:51:48 2004