OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::RenderWindow Class Referenceabstract

Manages the target rendering window. More...

#include <OgreRenderWindow.h>

+ Inheritance diagram for Ogre::RenderWindow:

Public Member Functions

 RenderWindow ()
 Default constructor. More...
 
virtual void create (const String &name, unsigned int widthPt, unsigned int heightPt, bool fullScreen, const NameValuePairList *miscParams)=0
 Creates & displays the new window. More...
 
virtual void destroy (void)=0
 Destroys the window. More...
 
virtual void getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
 Retrieve information about the render target. More...
 
virtual void getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth, int &left, int &top) const
 Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. More...
 
virtual float getViewPointToPixelScale ()
 Many windowing systems that support HiDPI displays use special points to specify size of the windows and controls, so that windows and controls with hardcoded sizes does not become too small on HiDPI displays. More...
 
virtual unsigned int getVSyncInterval () const
 Returns the vertical sync interval. More...
 
virtual bool isActive (void) const
 Overridden from RenderTarget, flags invisible windows as inactive. More...
 
virtual bool isClosed (void) const =0
 Indicates whether the window has been closed by the user. More...
 
bool isDeactivatedOnFocusChange () const
 Returns true if the window will automatically de-activate itself when it loses focus. More...
 
virtual bool isFullScreen (void) const
 Returns true if window is running in fullscreen mode. More...
 
virtual bool isHidden (void) const
 Indicates whether the window was set to hidden (not displayed) More...
 
virtual bool isPrimary (void) const
 Indicates whether the window is the primary window. More...
 
virtual bool isVisible (void) const
 Indicates whether the window is visible (not minimized or obscured) More...
 
virtual bool isVSyncEnabled () const
 Indicates whether vertical sync is activated for the window. More...
 
virtual void reposition (int leftPt, int topPt)=0
 Reposition the window. More...
 
virtual void resize (unsigned int widthPt, unsigned int heightPt)=0
 Alter the size of the window. More...
 
void setDeactivateOnFocusChange (bool deactivate)
 Indicates whether the window will automatically deactivate itself when it loses focus. More...
 
virtual void setFullscreen (bool fullScreen, unsigned int widthPt, unsigned int heightPt)
 Alter fullscreen mode options. More...
 
virtual void setHidden (bool hidden)
 Hide (or show) the window. More...
 
virtual void setVisible (bool visible)
 Set the visibility state. More...
 
virtual void setVSyncEnabled (bool vsync)
 Enable or disable vertical sync for the RenderWindow. More...
 
virtual void setVSyncInterval (unsigned int interval)
 Set the vertical sync interval. More...
 
PixelFormat suggestPixelFormat () const
 Override since windows don't usually have alpha. More...
 
virtual void windowMovedOrResized ()
 Notify that the window has been resized. More...
 
- Public Member Functions inherited from Ogre::RenderTarget
 RenderTarget ()
 
virtual ~RenderTarget ()
 
virtual void _beginUpdate ()
 Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. More...
 
virtual void _detachDepthBuffer ()
 Detaches DepthBuffer without notifying it from the detach. More...
 
virtual void _endUpdate ()
 Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. More...
 
virtual Impl_getImpl ()
 Get rendersystem specific interface for this RenderTarget. More...
 
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. More...
 
virtual void _updateAutoUpdatedViewports (bool updateStatistics=true)
 Method for manual management of rendering - renders only viewports that are auto updated. More...
 
virtual void _updateViewport (int zorder, bool updateStatistics=true)
 Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...
 
virtual void _updateViewport (Viewport *viewport, bool updateStatistics=true)
 Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...
 
virtual void addListener (RenderTargetListener *listener)
 Add a listener to this RenderTarget which will be called back before & after rendering. More...
 
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. More...
 
virtual bool attachDepthBuffer (DepthBuffer *depthBuffer)
 
virtual void copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO)=0
 Copies the current contents of the render target to a pixelbox. More...
 
void copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
virtual void detachDepthBuffer ()
 
virtual uint32 getColourDepth (void) const
 
uint getCustomAttribute (const String &name)
 simplified API for bindings More...
 
virtual void getCustomAttribute (const String &name, void *pData)
 Retrieve a platform or API-specific piece of information. More...
 
DepthBuffergetDepthBuffer () const
 
uint16 getDepthBufferPool () const
 
virtual uint getFSAA () const
 Indicates whether multisampling is performed on rendering and at what level. More...
 
virtual const StringgetFSAAHint () const
 Gets the FSAA hint (. More...
 
virtual uint32 getHeight (void) const
 
virtual void getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
 Retrieve information about the render target. More...
 
virtual const StringgetName (void) const
 Retrieve target's name. More...
 
virtual unsigned short getNumViewports (void) const
 Returns the number of viewports attached to this target. More...
 
virtual uchar getPriority () const
 Gets the priority of a render target. More...
 
const FrameStatsgetStatistics (void) const
 Retieves details of current rendering performance. More...
 
virtual ViewportgetViewport (unsigned short index)
 Retrieves a pointer to the viewport with the given index. More...
 
virtual ViewportgetViewportByZOrder (int ZOrder)
 Retrieves a pointer to the viewport with the given Z-order. More...
 
virtual uint32 getWidth (void) const
 
virtual bool hasViewportWithZOrder (int ZOrder)
 Returns true if and only if a viewport exists at the given Z-order. More...
 
virtual void insertListener (RenderTargetListener *listener, const unsigned int pos=0)
 same as addListener, but force the position in the vector, so we can control the call order More...
 
virtual bool isAutoUpdated (void) const
 Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
 
virtual bool isHardwareGammaEnabled () const
 Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. More...
 
virtual bool isStereoEnabled (void) const
 Indicates whether stereo is currently enabled for this target. More...
 
virtual void removeAllListeners (void)
 Removes all listeners from this instance. More...
 
virtual void removeAllViewports (void)
 Removes all viewports on this target. More...
 
virtual void removeListener (RenderTargetListener *listener)
 Removes a RenderTargetListener previously registered using addListener. More...
 
virtual void removeViewport (int ZOrder)
 Removes a viewport at a given Z-order. More...
 
virtual bool requiresTextureFlipping () const =0
 
void resetStatistics (void)
 Resets saved frame-rate statistices. More...
 
virtual void setActive (bool state)
 Used to set the active state of the render target. More...
 
virtual void setAutoUpdated (bool autoupdate)
 Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
 
void setDepthBufferPool (uint16 poolId)
 Sets the pool ID this RenderTarget should query from. More...
 
virtual void setFSAA (uint fsaa, const String &fsaaHint)
 Set the level of multisample AA to be used if hardware support it. More...
 
virtual void setPriority (uchar priority)
 Sets the priority of this render target in relation to the others. More...
 
virtual void swapBuffers ()
 Swaps the frame buffers to display the next frame. More...
 
virtual void update (bool swapBuffers=true)
 Tells the target to update it's contents. More...
 
void writeContentsToFile (const String &filename)
 Writes the current contents of the render target to the named file. More...
 
virtual String writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
 Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::RenderTarget
enum  FrameBuffer { FB_FRONT, FB_BACK, FB_AUTO }
 
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
}
 

Detailed Description

Manages the target rendering window.

Remarks
This class handles a window into which the contents of a scene are rendered. There is a many-to-1 relationship between instances of this class an instance of RenderSystem which controls the rendering of the scene. There may be more than one window in the case of level editor tools etc. This class is abstract since there may be different implementations for different windowing systems.
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).
Author
Steven Streeting
Version
1.0

Constructor & Destructor Documentation

◆ RenderWindow()

Ogre::RenderWindow::RenderWindow ( )

Default constructor.

Member Function Documentation

◆ getViewPointToPixelScale()

virtual float Ogre::RenderWindow::getViewPointToPixelScale ( )
inlinevirtual

Many windowing systems that support HiDPI displays use special points to specify size of the windows and controls, so that windows and controls with hardcoded sizes does not become too small on HiDPI displays.

Such points have constant density ~ 100 points per inch (probably 96 on Windows and 72 on Mac), that is independent of pixel density of real display, and are used through the all windowing system.

Sometimes, such view points are choosen bigger for output devices that are viewed from larger distances, like 30" TV comparing to 30" monitor, therefore maintaining constant points angular density rather than constant linear density.

In any case, all such windowing system provides the way to convert such view points to pixels, be it DisplayProperties::LogicalDpi on WinRT or backingScaleFactor on MacOSX. We use pixels consistently through the Ogre, but window/view management functions takes view points for convenience, as does the rest of windowing system. Such parameters are named using xxxxPt pattern, and should not be mixed with pixels without being converted using getViewPointToPixelScale() function.

Sometimes such scale factor can change on-the-fly, for example if window is dragged to monitor with different DPI. In such situation, window size in view points is usually preserved by windowing system, and Ogre should adjust pixel size of RenderWindow.

Reimplemented in Ogre::MetalRenderWindow.

◆ create()

virtual void Ogre::RenderWindow::create ( const String name,
unsigned int  widthPt,
unsigned int  heightPt,
bool  fullScreen,
const NameValuePairList miscParams 
)
pure virtual

Creates & displays the new window.

Parameters
namethe internal window name. Not necessarily the title.
widthPtThe width of the window in view points.
heightPtThe height of the window in view points.
fullScreenIf true, the window fills the screen, with no title bar or border.
miscParamsA variable number of pointers to platform-specific arguments. The actual requirements must be defined by the implementing subclasses.

Implemented in Ogre::MetalRenderWindow, and Ogre::D3D9RenderWindow.

◆ setFullscreen()

virtual void Ogre::RenderWindow::setFullscreen ( bool  fullScreen,
unsigned int  widthPt,
unsigned int  heightPt 
)
inlinevirtual

Alter fullscreen mode options.

Note
Nothing will happen unless the settings here are different from the current settings.
Parameters
fullScreenWhether to use fullscreen mode or not.
widthPtThe new width to use
heightPtThe new height to use

Reimplemented in Ogre::D3D9RenderWindow.

◆ destroy()

virtual void Ogre::RenderWindow::destroy ( void  )
pure virtual

◆ resize()

virtual void Ogre::RenderWindow::resize ( unsigned int  widthPt,
unsigned int  heightPt 
)
pure virtual

Alter the size of the window.

Implemented in Ogre::MetalRenderWindow, Ogre::D3D9RenderWindow, and Ogre::D3D11RenderWindowBase.

◆ windowMovedOrResized()

virtual void Ogre::RenderWindow::windowMovedOrResized ( )
inlinevirtual

Notify that the window has been resized.

Remarks
You don't need to call this unless you created the window externally.

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

◆ reposition()

virtual void Ogre::RenderWindow::reposition ( int  leftPt,
int  topPt 
)
pure virtual

Reposition the window.

Implemented in Ogre::MetalRenderWindow, Ogre::D3D9RenderWindow, and Ogre::D3D11RenderWindowBase.

◆ isVisible()

virtual bool Ogre::RenderWindow::isVisible ( void  ) const
inlinevirtual

Indicates whether the window is visible (not minimized or obscured)

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

◆ setVisible()

virtual void Ogre::RenderWindow::setVisible ( bool  visible)
inlinevirtual

Set the visibility state.

Reimplemented in Ogre::GLWindow.

◆ isHidden()

virtual bool Ogre::RenderWindow::isHidden ( void  ) const
inlinevirtual

Indicates whether the window was set to hidden (not displayed)

Reimplemented in Ogre::GLWindow, Ogre::D3D11RenderWindowBase, and Ogre::D3D9RenderWindow.

◆ setHidden()

virtual void Ogre::RenderWindow::setHidden ( bool  hidden)
inlinevirtual

Hide (or show) the window.

If called with hidden=true, this will make the window completely invisible to the user.

Remarks
Setting a window to hidden is useful to create a dummy primary RenderWindow hidden from the user so that you can create and recreate your actual RenderWindows without having to recreate all your resources.

Reimplemented in Ogre::D3D9RenderWindow.

◆ setVSyncEnabled()

virtual void Ogre::RenderWindow::setVSyncEnabled ( bool  vsync)
inlinevirtual

Enable or disable vertical sync for the RenderWindow.

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

◆ isVSyncEnabled()

virtual bool Ogre::RenderWindow::isVSyncEnabled ( ) const
inlinevirtual

Indicates whether vertical sync is activated for the window.

Reimplemented in Ogre::D3D11RenderWindowSwapChainBased, Ogre::D3D9RenderWindow, and Ogre::GLWindow.

◆ setVSyncInterval()

virtual void Ogre::RenderWindow::setVSyncInterval ( unsigned int  interval)
inlinevirtual

Set the vertical sync interval.

This indicates the number of vertical retraces to wait for before swapping buffers. A value of 1 is the default.

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

◆ getVSyncInterval()

virtual unsigned int Ogre::RenderWindow::getVSyncInterval ( ) const
inlinevirtual

Returns the vertical sync interval.

Reimplemented in Ogre::D3D11RenderWindowSwapChainBased, Ogre::D3D9RenderWindow, and Ogre::GLWindow.

◆ isActive()

virtual bool Ogre::RenderWindow::isActive ( void  ) const
inlinevirtual

Overridden from RenderTarget, flags invisible windows as inactive.

Reimplemented from Ogre::RenderTarget.

Reimplemented in Ogre::D3D9RenderWindow.

◆ isClosed()

virtual bool Ogre::RenderWindow::isClosed ( void  ) const
pure virtual

Indicates whether the window has been closed by the user.

Implemented in Ogre::MetalRenderWindow, Ogre::GLWindow, Ogre::D3D11RenderWindowBase, and Ogre::D3D9RenderWindow.

◆ isPrimary()

virtual bool Ogre::RenderWindow::isPrimary ( void  ) const
virtual

Indicates whether 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.

◆ isFullScreen()

virtual bool Ogre::RenderWindow::isFullScreen ( void  ) const
virtual

Returns true if window is running in fullscreen mode.

◆ getMetrics() [1/2]

virtual void Ogre::RenderWindow::getMetrics ( unsigned int &  width,
unsigned int &  height,
unsigned int &  colourDepth,
int &  left,
int &  top 
) const
virtual

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

Result is in pixels.

◆ suggestPixelFormat()

PixelFormat Ogre::RenderWindow::suggestPixelFormat ( ) const
inlinevirtual

Override since windows don't usually have alpha.

Reimplemented from Ogre::RenderTarget.

Reimplemented in Ogre::MetalRenderWindow.

References Ogre::PF_BYTE_RGB.

◆ isDeactivatedOnFocusChange()

bool Ogre::RenderWindow::isDeactivatedOnFocusChange ( ) const

Returns true if the window will automatically de-activate itself when it loses focus.

◆ setDeactivateOnFocusChange()

void Ogre::RenderWindow::setDeactivateOnFocusChange ( bool  deactivate)

Indicates whether the window will automatically deactivate itself when it loses focus.

Parameters
deactivatea value of 'true' will cause the window to deactivate itself when it loses focus. 'false' will allow it to continue to render even when window focus is lost.
Note
'true' is the default behavior.

◆ getMetrics() [2/2]

virtual void Ogre::RenderTarget::getMetrics

Retrieve information about the render target.


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