OGRE  2.2.4
Object-Oriented Graphics Rendering Engine
Public Member Functions | List of all members
Ogre::GLXWindow Class Reference

#include <OgreGLXWindow.h>

+ Inheritance diagram for Ogre::GLXWindow:

Public Member Functions

 GLXWindow (const String &title, uint32 width, uint32 height, bool fullscreenMode, PixelFormatGpu depthStencilFormat, const NameValuePairList *miscParams, GLXGLSupport *glsupport)
 
virtual ~GLXWindow ()
 
virtual void _initialize (TextureGpuManager *textureManager)
 
void _setPrimary (void)
 Indicates that this is the primary window. More...
 
virtual void _setVisible (bool visible)
 Internal method to notify the window it has been obscured or minimized. More...
 
virtual void destroy (void)
 RenderWindow::destroy More...
 
bool getBorderless (void) const
 
virtual void getCustomAttribute (IdString name, void *pData)
 
TextureGpu * getDepthBuffer (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
 
TextureGpu * getStencilBuffer (void) const
 
TextureGpu * getTexture (void) const
 WARNING: Attempting to change the TextureGpu (e.g. More...
 
const String & getTitle (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
 RenderWindow::isClosed More...
 
bool isFocused (void) const
 
bool isFullscreen (void) const
 Returns true if we are currently in fullscreen mode. More...
 
bool isHidden (void) const
 RenderWindow::isHidden More...
 
bool isMultisample (void) const
 
bool isPrimary (void) const
 
bool isVisible (void) const
 RenderWindow::isVisible More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
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 * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
virtual void reposition (int32 left, int32 top)
 
void requestFullscreenSwitch (bool goFullscreen, bool borderless, uint32 monitorIdx, uint32 width, uint32 height, uint32 frequencyNumerator, uint32 frequencyDenominator)
 Requests to toggle between fullscreen and windowed mode. More...
 
void requestResolution (uint32 width, uint32 height)
 RenderWindow::resize More...
 
bool requiresTextureFlipping () const
 
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...
 
void setHidden (bool hidden)
 RenderWindow::setHidden More...
 
virtual void setTitle (const String &title)
 
virtual void setVSync (bool vSync, uint32 vSyncInterval)
 
void swapBuffers ()
 RenderWindow::swapBuffers More...
 
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...
 
void windowMovedOrResized ()
 RenderWindow::windowMovedOrResized More...
 

Constructor & Destructor Documentation

◆ GLXWindow()

Ogre::GLXWindow::GLXWindow ( const String &  title,
uint32  width,
uint32  height,
bool  fullscreenMode,
PixelFormatGpu  depthStencilFormat,
const NameValuePairList *  miscParams,
GLXGLSupport *  glsupport 
)

◆ ~GLXWindow()

virtual Ogre::GLXWindow::~GLXWindow ( )
virtual

Member Function Documentation

◆ _initialize()

virtual void Ogre::GLXWindow::_initialize ( TextureGpuManager *  textureManager)
virtual

Implements Ogre::Window.

◆ _setPrimary()

void Ogre::Window::_setPrimary ( void  )
inherited

Indicates that this is the primary window.

Only to be called by Ogre::Root

◆ _setVisible()

virtual void Ogre::GLXWindow::_setVisible ( bool  visible)
virtual

Internal method to notify the window it has been obscured or minimized.

Implements Ogre::Window.

◆ destroy()

virtual void Ogre::GLXWindow::destroy ( void  )
virtual

RenderWindow::destroy

RenderWindow::destroy

Implements Ogre::Window.

◆ getBorderless()

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

◆ getCustomAttribute()

virtual void Ogre::GLXWindow::getCustomAttribute ( IdString  name,
void *  pData 
)
virtual
Remarks
Get custom attribute; the following attributes are valid: WINDOW The X Window target for rendering. GLCONTEXT The Ogre GL3PlusContext used for rendering. DISPLAY The X Display connection behind that context. DISPLAYNAME The X Server name for the connected display. ATOM The X Atom used in client delete events.

Reimplemented from Ogre::Window.

◆ getDepthBuffer()

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

◆ getFrequencyDenominator()

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

◆ getFrequencyNumerator()

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

◆ getHeight()

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

◆ getMetrics()

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

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

Result is in pixels.

◆ getPixelFormat()

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

◆ getRequestedHeightPt()

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

◆ getRequestedWidthPt()

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

◆ getSampleDescription()

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

◆ getStencilBuffer()

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

◆ getTexture()

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

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

setResolution, setPixelFormat) is undefined behavior

◆ getTitle()

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

◆ getViewPointToPixelScale()

virtual float Ogre::Window::getViewPointToPixelScale ( ) const
inlinevirtualinherited

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::MetalWindow.

◆ getVSync()

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

◆ getVSyncInterval()

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

◆ getWidth()

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

◆ isClosed()

virtual bool Ogre::GLXWindow::isClosed ( void  ) const
virtual

RenderWindow::isClosed

RenderWindow::isClosed

Implements Ogre::Window.

◆ isFocused()

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

◆ isFullscreen()

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

Returns true if we are currently in fullscreen mode.

◆ isHidden()

bool Ogre::GLXWindow::isHidden ( void  ) const
inlinevirtual

RenderWindow::isHidden

RenderWindow::isHidden

Implements Ogre::Window.

◆ isMultisample()

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

◆ isPrimary()

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

◆ isVisible()

bool Ogre::GLXWindow::isVisible ( void  ) const
virtual

RenderWindow::isVisible

RenderWindow::isVisible

Implements Ogre::Window.

◆ 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,
void *   
)
inlineinherited

◆ operator delete() [3/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
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,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

◆ operator new() [2/3]

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

◆ 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,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

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

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

◆ reposition()

virtual void Ogre::GLXWindow::reposition ( int32  left,
int32  top 
)
virtual

Implements Ogre::Window.

◆ requestFullscreenSwitch()

void Ogre::GLXWindow::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 from Ogre::Window.

◆ requestResolution()

void Ogre::GLXWindow::requestResolution ( uint32  width,
uint32  height 
)
virtual

RenderWindow::resize

RenderWindow::resize

Reimplemented from Ogre::Window.

◆ requiresTextureFlipping()

bool Ogre::GLXWindow::requiresTextureFlipping ( ) const
inline

◆ setBorderless()

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

◆ setFocused()

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

Reimplemented in Ogre::Win32Window.

◆ setFsaa()

virtual void Ogre::Window::setFsaa ( const String &  fsaa)
inlinevirtualinherited

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

void Ogre::GLXWindow::setHidden ( bool  hidden)
virtual

RenderWindow::setHidden

RenderWindow::setHidden

Implements Ogre::Window.

◆ setTitle()

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

◆ setVSync()

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

Reimplemented from Ogre::Window.

◆ swapBuffers()

void Ogre::GLXWindow::swapBuffers ( )
virtual

RenderWindow::swapBuffers

RenderWindow::swapBuffers

Implements Ogre::Window.

◆ wantsToGoFullscreen()

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

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

◆ wantsToGoWindowed()

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

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

◆ windowMovedOrResized()

void Ogre::GLXWindow::windowMovedOrResized ( )
virtual

RenderWindow::windowMovedOrResized

RenderWindow::windowMovedOrResized

Reimplemented from Ogre::Window.

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