OGRE  2.3
Object-Oriented Graphics Rendering Engine
Ogre::Window Class Referenceabstract

#include <OgreWindow.h>

+ Inheritance diagram for Ogre::Window:

Public Member Functions

 Window (const String &title, uint32 widthPt, uint32 heightPt, bool fullscreenMode)
 
virtual ~Window ()
 
virtual void _initialize (TextureGpuManager *textureGpuManager)=0
 
void _setPrimary (void)
 Indicates that this is the primary window. More...
 
virtual void _setVisible (bool visible)=0
 Internal method to notify the window it has been obscured or minimized. More...
 
virtual void destroy (void)=0
 
bool getBorderless (void) const
 
virtual void getCustomAttribute (IdString name, void *pData)
 
TextureGpugetDepthBuffer (void) const
 
uint32 getFrequencyDenominator (void) const
 
uint32 getFrequencyNumerator (void) const
 
uint32 getHeight (void) const
 
virtual void getMetrics (uint32 &width, uint32 &height, int32 &left, int32 &top) const
 Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. More...
 
PixelFormatGpu getPixelFormat (void) const
 
uint32 getRequestedHeightPt (void) const
 
uint32 getRequestedWidthPt (void) const
 
SampleDescription getSampleDescription (void) const
 
TextureGpugetStencilBuffer (void) const
 
TextureGpugetTexture (void) const
 WARNING: Attempting to change the TextureGpu (e.g. More...
 
const StringgetTitle (void) const
 
virtual float getViewPointToPixelScale () const
 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...
 
bool getVSync (void) const
 
uint32 getVSyncInterval (void) const
 
uint32 getWidth (void) const
 
virtual bool isClosed (void) const =0
 Indicates whether the window has been closed by the user. More...
 
bool isFocused (void) const
 
bool isFullscreen (void) const
 Returns true if we are currently in fullscreen mode. More...
 
virtual bool isHidden (void) const =0
 Indicates whether the window was set to hidden (not displayed) More...
 
bool isMultisample (void) const
 
bool isPrimary (void) const
 
virtual bool isVisible (void) const =0
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
virtual void reposition (int32 leftPt, int32 topPt)=0
 
virtual void requestFullscreenSwitch (bool goFullscreen, bool borderless, uint32 monitorIdx, uint32 widthPt, uint32 heightPt, uint32 frequencyNumerator, uint32 frequencyDenominator)
 Requests to toggle between fullscreen and windowed mode. More...
 
virtual void requestResolution (uint32 widthPt, uint32 heightPt)
 Requests a change in resolution. More...
 
virtual void setBorderless (bool borderless)
 
virtual void setFocused (bool focused)
 
virtual void setFsaa (const String &fsaa)
 Set the FSAA mode to be used if hardware support it. More...
 
virtual void setHidden (bool hidden)=0
 Hide (or show) the window. More...
 
virtual void setTitle (const String &title)
 
virtual void setVSync (bool vSync, uint32 vSyncInterval)
 Turns VSync on/off. More...
 
virtual void swapBuffers (void)=0
 
bool wantsToGoFullscreen (void) const
 Returns true if we are in windowed mode right now, but want to go fullscreen. More...
 
bool wantsToGoWindowed (void) const
 Returns true if we are in fullscreen mode right now, but want to go windowed mode. More...
 
virtual void windowMovedOrResized (void)
 Notify that the window has been resized. More...
 

Constructor & Destructor Documentation

◆ Window()

Ogre::Window::Window ( const String title,
uint32  widthPt,
uint32  heightPt,
bool  fullscreenMode 
)

◆ ~Window()

virtual Ogre::Window::~Window ( )
virtual

Member Function Documentation

◆ _initialize()

◆ _setPrimary()

void Ogre::Window::_setPrimary ( void  )

Indicates that this is the primary window.

Only to be called by Ogre::Root

◆ _setVisible()

virtual void Ogre::Window::_setVisible ( bool  visible)
pure virtual

◆ destroy()

◆ getBorderless()

bool Ogre::Window::getBorderless ( void  ) const

◆ getCustomAttribute()

◆ getDepthBuffer()

TextureGpu* Ogre::Window::getDepthBuffer ( void  ) const

◆ getFrequencyDenominator()

uint32 Ogre::Window::getFrequencyDenominator ( void  ) const

◆ getFrequencyNumerator()

uint32 Ogre::Window::getFrequencyNumerator ( void  ) const

◆ getHeight()

uint32 Ogre::Window::getHeight ( void  ) const

◆ getMetrics()

virtual void Ogre::Window::getMetrics ( uint32 width,
uint32 height,
int32 left,
int32 top 
) const
virtual

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

Result is in pixels.

◆ getPixelFormat()

PixelFormatGpu Ogre::Window::getPixelFormat ( void  ) const

◆ getRequestedHeightPt()

uint32 Ogre::Window::getRequestedHeightPt ( void  ) const

◆ getRequestedWidthPt()

uint32 Ogre::Window::getRequestedWidthPt ( void  ) const

◆ getSampleDescription()

SampleDescription Ogre::Window::getSampleDescription ( void  ) const

◆ getStencilBuffer()

TextureGpu* Ogre::Window::getStencilBuffer ( void  ) const

◆ getTexture()

TextureGpu* Ogre::Window::getTexture ( void  ) const

WARNING: Attempting to change the TextureGpu (e.g.

setResolution, setPixelFormat) is undefined behavior

◆ getTitle()

const String& Ogre::Window::getTitle ( void  ) const

◆ getViewPointToPixelScale()

virtual float Ogre::Window::getViewPointToPixelScale ( ) const
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::CocoaWindow, and Ogre::MetalWindow.

◆ getVSync()

bool Ogre::Window::getVSync ( void  ) const

◆ getVSyncInterval()

uint32 Ogre::Window::getVSyncInterval ( void  ) const

◆ getWidth()

uint32 Ogre::Window::getWidth ( void  ) const

◆ isClosed()

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

◆ isFocused()

bool Ogre::Window::isFocused ( void  ) const

◆ isFullscreen()

bool Ogre::Window::isFullscreen ( void  ) const

Returns true if we are currently in fullscreen mode.

◆ isHidden()

virtual bool Ogre::Window::isHidden ( void  ) const
pure virtual

◆ isMultisample()

bool Ogre::Window::isMultisample ( void  ) const

◆ isPrimary()

bool Ogre::Window::isPrimary ( void  ) const

◆ isVisible()

◆ operator delete() [1/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

◆ operator delete() [2/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator delete() [3/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator new() [1/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

◆ operator new() [2/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

◆ reposition()

◆ requestFullscreenSwitch()

virtual void Ogre::Window::requestFullscreenSwitch ( bool  goFullscreen,
bool  borderless,
uint32  monitorIdx,
uint32  widthPt,
uint32  heightPt,
uint32  frequencyNumerator,
uint32  frequencyDenominator 
)
virtual

Requests to toggle between fullscreen and windowed mode.

Remarks
Use wantsToGoFullscreen & wantsToGoWindowed to know what you've requested. Same remarks as requestResolution apply: If we request to go fullscreen, wantsToGoFullscreen will return true. But if get word from OS saying we stay in windowed mode, wantsToGoFullscreen will start returning false.
Parameters
goFullscreenTrue to go fullscreen, false to go windowed mode.
borderlessWhether to be borderless. Only useful if goFullscreen == false;
monitorIdx
widthNew width. Leave 0 if you don't care.
heightNew height. Leave 0 if you don't care.
frequencyNumeratorNew frequency (fullscreen only). Leave 0 if you don't care.
frequencyDenominatorNew frequency (fullscreen only). Leave 0 if you don't care.

Reimplemented in Ogre::VulkanXcbWindow, Ogre::VulkanWin32Window, Ogre::NULLWindow, Ogre::Win32Window, Ogre::GLXWindow, Ogre::EglPBufferWindow, and Ogre::EGLWindow.

◆ requestResolution()

virtual void Ogre::Window::requestResolution ( uint32  widthPt,
uint32  heightPt 
)
virtual

Requests a change in resolution.

Change is not immediate. Use getRequestedWidthPt & getRequestedHeightPt if you need to know what you've requested, but beware you may not get that resolution, and once we get word from the OS, getRequested{Width/Height}Pt will change again so that getWidth == getRequestedWidthPt * getViewPointToPixelScale.

Reimplemented in Ogre::VulkanXcbWindow, Ogre::VulkanWin32Window, Ogre::VulkanAndroidWindow, Ogre::NULLWindow, Ogre::MetalWindow, Ogre::Win32Window, Ogre::GLXWindow, Ogre::EglPBufferWindow, and Ogre::EGLWindow.

◆ setBorderless()

virtual void Ogre::Window::setBorderless ( bool  borderless)
virtual

◆ setFocused()

virtual void Ogre::Window::setFocused ( bool  focused)
virtual

◆ setFsaa()

virtual void Ogre::Window::setFsaa ( const String fsaa)
inlinevirtual

Set the FSAA mode to be used if hardware support it.

This option will be ignored if the hardware does not support it or setting can not be changed on the fly on per-target level.

Parameters
fsaaRequesed FSAA mode (
See also
Root::createRenderWindow)

Reimplemented in Ogre::D3D11WindowSwapChainBased.

◆ setHidden()

virtual void Ogre::Window::setHidden ( bool  hidden)
pure virtual

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.

Implemented in Ogre::CocoaWindow, Ogre::VulkanXcbWindow, Ogre::VulkanWin32Window, Ogre::VulkanAndroidWindow, Ogre::NULLWindow, Ogre::MetalWindow, Ogre::Win32Window, Ogre::GLXWindow, Ogre::EglPBufferWindow, Ogre::EGLWindow, and Ogre::D3D11Window.

◆ setTitle()

virtual void Ogre::Window::setTitle ( const String title)
virtual

◆ setVSync()

virtual void Ogre::Window::setVSync ( bool  vSync,
uint32  vSyncInterval 
)
virtual

Turns VSync on/off.

Parameters
vSync
vSyncIntervalWhen true, specifies how often the screen should be updated. e.g. at 60hz: vSyncInterval = 1 then update at 60hz vSyncInterval = 2 then update at 30hz vSyncInterval = 3 then update at 15hz vSyncInterval = 4 then update at 7.5hz

If the 31st bit is set, i.e. 0x80000000, then lowest latency mode, aka mailbox, will be used (which doesn't limit the framerate)

Reimplemented in Ogre::VulkanWindow, Ogre::Win32Window, Ogre::GLXWindow, Ogre::EglPBufferWindow, and Ogre::EGLWindow.

◆ swapBuffers()

◆ wantsToGoFullscreen()

bool Ogre::Window::wantsToGoFullscreen ( void  ) const

Returns true if we are in windowed mode right now, but want to go fullscreen.

◆ wantsToGoWindowed()

bool Ogre::Window::wantsToGoWindowed ( void  ) const

Returns true if we are in fullscreen mode right now, but want to go windowed mode.

◆ windowMovedOrResized()

virtual void Ogre::Window::windowMovedOrResized ( void  )
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::CocoaWindow, Ogre::VulkanXcbWindow, Ogre::VulkanWin32Window, Ogre::VulkanAndroidWindow, Ogre::MetalWindow, Ogre::Win32Window, Ogre::GLXWindow, and Ogre::EGLWindow.


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