#include <OgreRenderWindow.h>
Inheritance diagram for Ogre::RenderWindow:
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 | |
RenderWindow () | |
Default constructor. More... | |
virtual void | create (String name, int width, int height, int colourDepth, bool fullScreen, int left, int top, bool depthBuffer, void *miscParam,...)=0 |
Creates & displays the new window. More... | |
virtual void | destroy (void)=0 |
Destroys the window. More... | |
virtual void | resize (int width, int height)=0 |
Alter the size of the window. More... | |
virtual void | reposition (int left, int top)=0 |
Reposition the window. More... | |
virtual bool | isClosed (void)=0 |
Indicates whether the window has been closed by the user. More... | |
virtual void | swapBuffers (bool waitForVSync=true)=0 |
Swaps the frame buffers to display the next frame. More... | |
virtual void | update (void) |
Updates the window contents. More... | |
virtual bool | isFullScreen (void) |
Returns true if window is running in fullscreen mode. More... | |
virtual void | getMetrics (int &width, int &height, int &colourDepth, int &left, int &top) |
Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. More... | |
virtual String | getName (void) |
Retrieve target's name. More... | |
virtual void | getMetrics (int &width, int &height, int &colourDepth) |
Retrieve information about the render target. More... | |
virtual int | getWidth (void) |
virtual int | getHeight (void) |
virtual int | getColourDepth (void) |
virtual Viewport * | addViewport (Camera *cam, int ZOrder=0, float left=0, float top=0, float width=100, float height=100) |
Adds a viewport to the rendering target. More... | |
virtual unsigned short | getNumViewports (void) |
Returns the number of viewports attached to this target. More... | |
virtual Viewport * | getViewport (unsigned short index) |
Retrieves a pointer to the viewport with the given index. More... | |
virtual void | removeViewport (int ZOrder) |
Removes a viewport at a given ZOrder. More... | |
virtual void | removeAllViewports (void) |
Removes all viewports on this target. More... | |
virtual void | setStatsDisplay (StatFlags sf) |
DEPRECATED Set what kind of statistics display (if any) should be displayed by the system about this target. More... | |
virtual void | getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) |
Retieves details of current rendering performance. More... | |
virtual float | getLastFPS () |
Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered. More... | |
virtual float | getAverageFPS () |
Individual stats access - gets the average frames per second (FPS) since call to RenderSystem::startRendering. More... | |
virtual float | getBestFPS () |
Individual stats access - gets the best frames per second (FPS) since call to RenderSystem::startRendering. More... | |
virtual float | getWorstFPS () |
Individual stats access - gets the worst frames per second (FPS) since call to RenderSystem::startRendering. More... | |
virtual void | resetStatistics (void) |
Resets saved frame-rate statistices. More... | |
virtual void | outputText (int x, int y, const String &text)=0 |
DEPRECATED Outputs text to the target at the specified co-ordinates. More... | |
virtual void | getCustomAttribute (String name, void *pData) |
Gets a custom (maybe platform-specific) attribute. More... | |
virtual void | setDebugText (const String &text) |
Adds debug text to this window. More... | |
const String & | RenderTarget::getDebugText () const |
Returns the debug text. More... | |
virtual void | addListener (RenderTargetListener *listener) |
Add a listener to this RenderTarget which will be called back before & after rendering. More... | |
virtual void | removeListener (RenderTargetListener *listener) |
Removes a RenderTargetListener previously registered using addListener. More... | |
virtual void | removeAllListeners (void) |
Removes all listeners from this instance. More... | |
virtual void | setPriority (uchar priority) |
Sets the priority of this render target in relation to the others. More... | |
virtual uchar | getPriority () const |
Gets the priority of a render target. More... | |
virtual bool | isActive () const |
Used to retrieve or set the active state of the render target. More... | |
virtual void | setActive (bool state) |
Used to retrieve the active state of the render target. More... | |
virtual void | writeContentsToFile (const String &filename)=0 |
Writes the current contents of the render target to the named file. More... | |
virtual bool | requiresTextureFlipping () const=0 |
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. More... | |
virtual void | firePostUpdate (void) |
internal method for firing events. More... | |
Protected Attributes | |
bool | mIsFullScreen |
int | mLeft |
int | mTop |
String | mName |
The name of this target. More... | |
uchar | mPriority |
The priority of the render target. More... | |
int | mWidth |
int | mHeight |
int | mColourDepth |
bool | mIsDepthBuffered |
StatFlags | mStatFlags |
float | mLastFPS |
float | mAvgFPS |
float | mBestFPS |
float | mWorstFPS |
unsigned int | mTris |
String | mDebugText |
bool | mActive |
ViewportList | mViewportList |
List of viewports, map on Z-order. More... | |
RenderTargetListenerList | mListeners |
|
|
|
|
|
|
|
Default constructor.
|
|
Add a listener to this RenderTarget which will be called back before & after rendering.
|
|
Adds a viewport to the rendering target.
|
|
Creates & displays the new window.
Implemented in Ogre::D3D7RenderWindow. |
|
Destroys the window.
Implemented in Ogre::D3D7RenderWindow. |
|
internal method for firing events.
Reimplemented in Ogre::RenderTexture. |
|
internal method for firing events.
|
|
Individual stats access - gets the average frames per second (FPS) since call to RenderSystem::startRendering.
|
|
Individual stats access - gets the best frames per second (FPS) since call to RenderSystem::startRendering.
|
|
|
|
Gets a custom (maybe platform-specific) attribute.
Reimplemented in Ogre::D3D7RenderWindow. |
|
|
|
Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.
|
|
Retrieve information about the render target.
|
|
Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.
|
|
Retrieve target's name.
|
|
Returns the number of viewports attached to this target.
|
|
Gets the priority of a render target.
|
|
Retieves details of current rendering performance.
|
|
Retrieves a pointer to the viewport with the given index.
|
|
|
|
Individual stats access - gets the worst frames per second (FPS) since call to RenderSystem::startRendering.
|
|
Used to retrieve or set the active state of the render target.
Reimplemented in Ogre::D3D7RenderWindow. |
|
Indicates whether the window has been closed by the user.
Implemented in Ogre::D3D7RenderWindow. |
|
Returns true if window is running in fullscreen mode.
|
|
DEPRECATED Outputs text to the target at the specified co-ordinates.
Implemented in Ogre::D3D7RenderWindow. |
|
Removes all listeners from this instance.
|
|
Removes all viewports on this target.
|
|
Removes a RenderTargetListener previously registered using addListener.
|
|
Removes a viewport at a given ZOrder.
|
|
Returns the debug text.
|
|
Reposition the window.
Implemented in Ogre::D3D7RenderWindow. |
|
Implemented in Ogre::D3D7RenderWindow. |
|
Resets saved frame-rate statistices.
|
|
Alter the size of the window.
Implemented in Ogre::D3D7RenderWindow. |
|
Used to retrieve the active state of the render target.
Reimplemented in Ogre::D3D9RenderWindow. |
|
Adds debug text to this window.
|
|
Sets the priority of this render target in relation to the others.
|
|
DEPRECATED Set what kind of statistics display (if any) should be displayed by the system about this target.
|
|
Swaps the frame buffers to display the next frame.
Implemented in Ogre::D3D7RenderWindow. |
|
Updates the window contents.
Reimplemented from Ogre::RenderTarget. |
|
|
|
Writes the current contents of the render target to the named file.
Implemented in Ogre::D3D7RenderWindow. |
|
Reimplemented in Ogre::D3D7RenderWindow. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The name of this target.
|
|
The priority of the render target.
|
|
|
|
|
|
|
|
List of viewports, map on Z-order.
|
|
|
|
|
Copyright © 2002 by The OGRE Team