#include <OgreRenderWindow.h>
Public Types | |
enum | StatFlags { SF_NONE = 0, SF_FPS = 1, SF_AVG_FPS = 2, SF_BEST_FPS = 4, SF_WORST_FPS = 8, SF_TRIANGLE_COUNT = 16, SF_ALL = 0xFFFF } |
Public Member Functions | |
RenderWindow () | |
Default constructor. | |
virtual void | create (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams)=0 |
Creates & displays the new window. | |
virtual void | setFullscreen (bool fullScreen, unsigned int width, unsigned int height) |
Alter fullscreen mode options. | |
virtual void | destroy (void)=0 |
Destroys the window. | |
virtual void | resize (unsigned int width, unsigned int height)=0 |
Alter the size of the window. | |
virtual void | windowMovedOrResized () |
Notify that the window has been resized. | |
virtual void | reposition (int left, int top)=0 |
Reposition the window. | |
virtual bool | isVisible (void) const |
Indicates whether the window is visible (not minimized or obscured). | |
virtual void | setVisible (bool visible) |
Set the visibility state. | |
virtual bool | isActive (void) const |
Overridden from RenderTarget, flags invisible windows as inactive. | |
virtual bool | isClosed (void) const =0 |
Indicates whether the window has been closed by the user. | |
virtual bool | isPrimary (void) const |
Indicates wether the window is the primary window. | |
virtual void | swapBuffers (bool waitForVSync=true)=0 |
Swaps the frame buffers to display the next frame. | |
virtual void | update (void) |
Tells the target to update it's contents.
| |
virtual void | update (bool swapBuffers) |
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 const String & | getName (void) const |
Retrieve target's name. | |
virtual void | getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth) |
Retrieve information about the render target. | |
virtual unsigned int | getWidth (void) const |
virtual unsigned int | getHeight (void) const |
virtual unsigned int | getColourDepth (void) const |
virtual Viewport * | addViewport (Camera *cam, int ZOrder=0, float left=0.0f, float top=0.0f, float width=1.0f, float height=1.0f) |
Adds a viewport to the rendering target. | |
virtual unsigned short | getNumViewports (void) const |
Returns the number of viewports attached to this target. | |
virtual Viewport * | getViewport (unsigned short index) |
Retrieves a pointer to the viewport with the given index. | |
virtual void | removeViewport (int ZOrder) |
Removes a viewport at a given ZOrder. | |
virtual void | removeAllViewports (void) |
Removes all viewports on this target. | |
virtual void | getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) const |
Retieves details of current rendering performance. | |
virtual const FrameStats & | getStatistics (void) const |
virtual float | getLastFPS () const |
Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered. | |
virtual float | getAverageFPS () const |
Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering. | |
virtual float | getBestFPS () const |
Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering. | |
virtual float | getWorstFPS () const |
Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering. | |
virtual float | getBestFrameTime () const |
Individual stats access - gets the best frame time. | |
virtual float | getWorstFrameTime () const |
Individual stats access - gets the worst frame time. | |
virtual void | resetStatistics (void) |
Resets saved frame-rate statistices. | |
virtual void | getCustomAttribute (const String &name, void *pData) |
Gets a custom (maybe platform-specific) attribute. | |
virtual void | addListener (RenderTargetListener *listener) |
Add a listener to this RenderTarget which will be called back before & after rendering. | |
virtual void | removeListener (RenderTargetListener *listener) |
Removes a RenderTargetListener previously registered using addListener. | |
virtual void | removeAllListeners (void) |
Removes all listeners from this instance. | |
virtual void | setPriority (uchar priority) |
Sets the priority of this render target in relation to the others. | |
virtual uchar | getPriority () const |
Gets the priority of a render target. | |
virtual 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 void | writeContentsToFile (const String &filename)=0 |
Writes the current contents of the render target to the named file. | |
virtual String | writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix) |
Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. | |
virtual bool | requiresTextureFlipping () const =0 |
virtual size_t | getTriangleCount (void) const |
Gets the number of triangles rendered in the last update() call. | |
virtual size_t | getBatchCount (void) const |
Gets the number of batches rendered in the last update() call. | |
virtual void | _notifyCameraRemoved (const Camera *cam) |
Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer. | |
virtual Impl * | _getImpl () |
Get rendersystem specific interface for this RenderTarget. | |
Protected Types | |
typedef std::map < int, Viewport *, std::less< int > > | ViewportList |
typedef std::vector < RenderTargetListener * > | RenderTargetListenerList |
Protected Member Functions | |
void | _setPrimary () |
Indicates that this is the primary window. | |
void | updateStats (void) |
virtual void | firePreUpdate (void) |
internal method for firing events | |
virtual void | firePostUpdate (void) |
internal method for firing events | |
virtual void | fireViewportPreUpdate (Viewport *vp) |
internal method for firing events | |
virtual void | fireViewportPostUpdate (Viewport *vp) |
internal method for firing events | |
virtual void | fireViewportAdded (Viewport *vp) |
internal method for firing events | |
virtual void | fireViewportRemoved (Viewport *vp) |
internal method for firing events | |
Protected Attributes | |
bool | mIsFullScreen |
bool | mIsPrimary |
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 |
FrameStats | mStats |
Timer * | mTimer |
unsigned long | mLastSecond |
unsigned long | mLastTime |
size_t | mFrameCount |
bool | mActive |
bool | mAutoUpdate |
ViewportList | mViewportList |
List of viewports, map on Z-order. | |
RenderTargetListenerList | mListeners |
Friends | |
class | Root |
Instances are created and communicated with by the render system although client programs can get a reference to it from the render system if required for resizing or moving. Note that you can have multiple viewpoints in the window for effects like rear-view mirrors and picture-in-picture views (see Viewport and Camera).
Definition at line 55 of file OgreRenderWindow.h.
typedef std::map<int, Viewport*, std::less<int> > Ogre::RenderTarget::ViewportList [protected, inherited] |
Definition at line 335 of file OgreRenderTarget.h.
typedef std::vector<RenderTargetListener*> Ogre::RenderTarget::RenderTargetListenerList [protected, inherited] |
Definition at line 339 of file OgreRenderTarget.h.
enum Ogre::RenderTarget::StatFlags [inherited] |
Definition at line 62 of file OgreRenderTarget.h.
Ogre::RenderWindow::RenderWindow | ( | ) |
Default constructor.
virtual void Ogre::RenderWindow::create | ( | const String & | name, | |
unsigned int | width, | |||
unsigned int | height, | |||
bool | fullScreen, | |||
const NameValuePairList * | miscParams | |||
) | [pure virtual] |
Creates & displays the new window.
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. |
virtual void Ogre::RenderWindow::setFullscreen | ( | bool | fullScreen, | |
unsigned int | width, | |||
unsigned int | height | |||
) | [virtual] |
Alter fullscreen mode options.
fullScreen | Whether to use fullscreen mode or not. | |
width | The new width to use | |
height | The new height to use |
Definition at line 96 of file OgreRenderWindow.h.
virtual void Ogre::RenderWindow::destroy | ( | void | ) | [pure virtual] |
Destroys the window.
virtual void Ogre::RenderWindow::resize | ( | unsigned int | width, | |
unsigned int | height | |||
) | [pure virtual] |
Alter the size of the window.
virtual void Ogre::RenderWindow::windowMovedOrResized | ( | ) | [virtual] |
Notify that the window has been resized.
Definition at line 110 of file OgreRenderWindow.h.
virtual void Ogre::RenderWindow::reposition | ( | int | left, | |
int | top | |||
) | [pure virtual] |
Reposition the window.
virtual bool Ogre::RenderWindow::isVisible | ( | void | ) | const [virtual] |
Indicates whether the window is visible (not minimized or obscured).
Definition at line 118 of file OgreRenderWindow.h.
virtual void Ogre::RenderWindow::setVisible | ( | bool | visible | ) | [virtual] |
virtual bool Ogre::RenderWindow::isActive | ( | void | ) | const [virtual] |
Overridden from RenderTarget, flags invisible windows as inactive.
Reimplemented from Ogre::RenderTarget.
Definition at line 126 of file OgreRenderWindow.h.
virtual bool Ogre::RenderWindow::isClosed | ( | void | ) | const [pure virtual] |
Indicates whether the window has been closed by the user.
virtual bool Ogre::RenderWindow::isPrimary | ( | void | ) | const [virtual] |
Indicates wether the window is the primary window.
The primary window is special in that it is destroyed when ogre is shut down, and cannot be destroyed directly. This is the case because it holds the context for vertex, index buffers and textures.
Reimplemented from Ogre::RenderTarget.
virtual void Ogre::RenderWindow::swapBuffers | ( | bool | waitForVSync = true |
) | [pure virtual] |
Swaps the frame buffers to display the next frame.
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). |
virtual void Ogre::RenderWindow::update | ( | void | ) | [virtual] |
Tells the target to update it's contents.
Reimplemented from Ogre::RenderTarget.
virtual void Ogre::RenderWindow::update | ( | bool | swapBuffers | ) | [virtual] |
Updates the window contents.
swapBuffers | If set to true, the window will immediately swap it's buffers after update. Otherwise, the buffers are not swapped, and you have to call swapBuffers yourself sometime later. You might want to do this on some rendersystems which pause for queued rendering commands to complete before accepting swap buffers calls - so you could do other CPU tasks whilst the queued commands complete. Or, you might do this if you want custom control over your windows, such as for externally created windows. |
virtual bool Ogre::RenderWindow::isFullScreen | ( | void | ) | const [virtual] |
Returns true if window is running in fullscreen mode.
virtual void Ogre::RenderWindow::getMetrics | ( | unsigned int & | width, | |
unsigned int & | height, | |||
unsigned int & | colourDepth, | |||
int & | left, | |||
int & | top | |||
) | [virtual] |
Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.
void Ogre::RenderWindow::_setPrimary | ( | ) | [protected] |
Indicates that this is the primary window.
Only to be called by Ogre::Root
Definition at line 199 of file OgreRenderWindow.h.
virtual const String& Ogre::RenderTarget::getName | ( | void | ) | const [virtual, inherited] |
Retrieve target's name.
virtual void Ogre::RenderTarget::getMetrics | ( | unsigned int & | width, | |
unsigned int & | height, | |||
unsigned int & | colourDepth | |||
) | [virtual, inherited] |
Retrieve information about the render target.
virtual unsigned int Ogre::RenderTarget::getWidth | ( | void | ) | const [virtual, inherited] |
virtual unsigned int Ogre::RenderTarget::getHeight | ( | void | ) | const [virtual, inherited] |
virtual unsigned int Ogre::RenderTarget::getColourDepth | ( | void | ) | const [virtual, inherited] |
virtual Viewport* Ogre::RenderTarget::addViewport | ( | Camera * | cam, | |
int | ZOrder = 0 , |
|||
float | left = 0.0f , |
|||
float | top = 0.0f , |
|||
float | width = 1.0f , |
|||
float | height = 1.0f | |||
) | [virtual, inherited] |
Adds a viewport to the rendering target.
cam | The camera from which the viewport contents will be rendered (mandatory) | |
ZOrder | The relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher ZOrders are on top of lower ones. The actual number is irrelevant, only the relative ZOrder matters (you can leave gaps in the numbering) | |
left | The relative position of the left of the viewport on the target, as a value between 0 and 1. | |
top | The relative position of the top of the viewport on the target, as a value between 0 and 1. | |
width | The relative width of the viewport on the target, as a value between 0 and 1. | |
height | The relative height of the viewport on the target, as a value between 0 and 1. |
virtual unsigned short Ogre::RenderTarget::getNumViewports | ( | void | ) | const [virtual, inherited] |
Returns the number of viewports attached to this target.
virtual Viewport* Ogre::RenderTarget::getViewport | ( | unsigned short | index | ) | [virtual, inherited] |
Retrieves a pointer to the viewport with the given index.
virtual void Ogre::RenderTarget::removeViewport | ( | int | ZOrder | ) | [virtual, inherited] |
Removes a viewport at a given ZOrder.
virtual void Ogre::RenderTarget::removeAllViewports | ( | void | ) | [virtual, inherited] |
Removes all viewports on this target.
virtual void Ogre::RenderTarget::getStatistics | ( | float & | lastFPS, | |
float & | avgFPS, | |||
float & | bestFPS, | |||
float & | worstFPS | |||
) | const [virtual, inherited] |
Retieves details of current rendering performance.
lastFPS | Pointer to a float to receive the number of frames per second (FPS) based on the last frame rendered. | |
avgFPS | Pointer to a float to receive the FPS rating based on an average of all the frames rendered since rendering began (the call to Root::startRendering). | |
bestFPS | Pointer to a float to receive the best FPS rating that has been achieved since rendering began. | |
worstFPS | Pointer to a float to receive the worst FPS rating seen so far. |
virtual const FrameStats& Ogre::RenderTarget::getStatistics | ( | void | ) | const [virtual, inherited] |
virtual float Ogre::RenderTarget::getLastFPS | ( | ) | const [virtual, inherited] |
Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.
virtual float Ogre::RenderTarget::getAverageFPS | ( | ) | const [virtual, inherited] |
Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering.
virtual float Ogre::RenderTarget::getBestFPS | ( | ) | const [virtual, inherited] |
Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering.
virtual float Ogre::RenderTarget::getWorstFPS | ( | ) | const [virtual, inherited] |
Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering.
virtual float Ogre::RenderTarget::getBestFrameTime | ( | ) | const [virtual, inherited] |
Individual stats access - gets the best frame time.
virtual float Ogre::RenderTarget::getWorstFrameTime | ( | ) | const [virtual, inherited] |
Individual stats access - gets the worst frame time.
virtual void Ogre::RenderTarget::resetStatistics | ( | void | ) | [virtual, inherited] |
Resets saved frame-rate statistices.
virtual void Ogre::RenderTarget::getCustomAttribute | ( | const String & | name, | |
void * | pData | |||
) | [virtual, inherited] |
Gets a custom (maybe platform-specific) attribute.
name | The name of the attribute. | |
pData | Pointer to memory of the right kind of structure to receive the info. |
virtual void Ogre::RenderTarget::addListener | ( | RenderTargetListener * | listener | ) | [virtual, inherited] |
Add a listener to this RenderTarget which will be called back before & after rendering.
virtual void Ogre::RenderTarget::removeListener | ( | RenderTargetListener * | listener | ) | [virtual, inherited] |
Removes a RenderTargetListener previously registered using addListener.
virtual void Ogre::RenderTarget::removeAllListeners | ( | void | ) | [virtual, inherited] |
Removes all listeners from this instance.
virtual void Ogre::RenderTarget::setPriority | ( | uchar | priority | ) | [virtual, inherited] |
Sets the priority of this render target in relation to the others.
Definition at line 236 of file OgreRenderTarget.h.
virtual uchar Ogre::RenderTarget::getPriority | ( | ) | const [virtual, inherited] |
virtual void Ogre::RenderTarget::setActive | ( | bool | state | ) | [virtual, inherited] |
Used to set the active state of the render target.
virtual void Ogre::RenderTarget::setAutoUpdated | ( | bool | autoupdate | ) | [virtual, inherited] |
Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
autoupdate | If true, the render target is updated during the automatic render loop or when Root::_updateAllRenderTargets is called. If false, the target is only updated when its update() method is called explicitly. |
virtual bool Ogre::RenderTarget::isAutoUpdated | ( | void | ) | const [virtual, inherited] |
Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.
virtual void Ogre::RenderTarget::writeContentsToFile | ( | const String & | filename | ) | [pure virtual, inherited] |
Writes the current contents of the render target to the named file.
Implemented in Ogre::RenderTexture, and Ogre::MultiRenderTarget.
virtual String Ogre::RenderTarget::writeContentsToTimestampedFile | ( | const String & | filenamePrefix, | |
const String & | filenameSuffix | |||
) | [virtual, inherited] |
Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.
virtual bool Ogre::RenderTarget::requiresTextureFlipping | ( | ) | const [pure virtual, inherited] |
virtual size_t Ogre::RenderTarget::getTriangleCount | ( | void | ) | const [virtual, inherited] |
Gets the number of triangles rendered in the last update() call.
virtual size_t Ogre::RenderTarget::getBatchCount | ( | void | ) | const [virtual, inherited] |
Gets the number of batches rendered in the last update() call.
virtual void Ogre::RenderTarget::_notifyCameraRemoved | ( | const Camera * | cam | ) | [virtual, inherited] |
Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.
virtual Impl* Ogre::RenderTarget::_getImpl | ( | ) | [virtual, inherited] |
Get rendersystem specific interface for this RenderTarget.
This is used by the RenderSystem to (un)bind this target, and to get specific information like surfaces and framebuffer objects.
void Ogre::RenderTarget::updateStats | ( | void | ) | [protected, inherited] |
virtual void Ogre::RenderTarget::firePreUpdate | ( | void | ) | [protected, virtual, inherited] |
internal method for firing events
virtual void Ogre::RenderTarget::firePostUpdate | ( | void | ) | [protected, virtual, inherited] |
internal method for firing events
virtual void Ogre::RenderTarget::fireViewportPreUpdate | ( | Viewport * | vp | ) | [protected, virtual, inherited] |
internal method for firing events
virtual void Ogre::RenderTarget::fireViewportPostUpdate | ( | Viewport * | vp | ) | [protected, virtual, inherited] |
internal method for firing events
virtual void Ogre::RenderTarget::fireViewportAdded | ( | Viewport * | vp | ) | [protected, virtual, inherited] |
internal method for firing events
virtual void Ogre::RenderTarget::fireViewportRemoved | ( | Viewport * | vp | ) | [protected, virtual, inherited] |
internal method for firing events
friend class Root [friend] |
Definition at line 201 of file OgreRenderWindow.h.
bool Ogre::RenderWindow::mIsFullScreen [protected] |
Definition at line 191 of file OgreRenderWindow.h.
bool Ogre::RenderWindow::mIsPrimary [protected] |
Definition at line 192 of file OgreRenderWindow.h.
int Ogre::RenderWindow::mLeft [protected] |
Definition at line 193 of file OgreRenderWindow.h.
int Ogre::RenderWindow::mTop [protected] |
Definition at line 194 of file OgreRenderWindow.h.
String Ogre::RenderTarget::mName [protected, inherited] |
uchar Ogre::RenderTarget::mPriority [protected, inherited] |
unsigned int Ogre::RenderTarget::mWidth [protected, inherited] |
Definition at line 317 of file OgreRenderTarget.h.
unsigned int Ogre::RenderTarget::mHeight [protected, inherited] |
Definition at line 318 of file OgreRenderTarget.h.
unsigned int Ogre::RenderTarget::mColourDepth [protected, inherited] |
Definition at line 319 of file OgreRenderTarget.h.
bool Ogre::RenderTarget::mIsDepthBuffered [protected, inherited] |
Definition at line 320 of file OgreRenderTarget.h.
FrameStats Ogre::RenderTarget::mStats [protected, inherited] |
Definition at line 323 of file OgreRenderTarget.h.
Timer* Ogre::RenderTarget::mTimer [protected, inherited] |
Definition at line 325 of file OgreRenderTarget.h.
unsigned long Ogre::RenderTarget::mLastSecond [protected, inherited] |
Definition at line 326 of file OgreRenderTarget.h.
unsigned long Ogre::RenderTarget::mLastTime [protected, inherited] |
Definition at line 327 of file OgreRenderTarget.h.
size_t Ogre::RenderTarget::mFrameCount [protected, inherited] |
Definition at line 328 of file OgreRenderTarget.h.
bool Ogre::RenderTarget::mActive [protected, inherited] |
Definition at line 330 of file OgreRenderTarget.h.
bool Ogre::RenderTarget::mAutoUpdate [protected, inherited] |
Definition at line 331 of file OgreRenderTarget.h.
ViewportList Ogre::RenderTarget::mViewportList [protected, inherited] |
RenderTargetListenerList Ogre::RenderTarget::mListeners [protected, inherited] |
Definition at line 340 of file OgreRenderTarget.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:52:25 2008