OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::GLWindow Class Reference

#include <OgreGLWindow.h>

+ Inheritance diagram for Ogre::GLWindow:

Public Member Functions

 GLWindow ()
 
void copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer)
 Copies the current contents of the render target to a pixelbox. More...
 
GLContextgetContext () const
 Get the GL context that needs to be active to render to this target. More...
 
unsigned int getVSyncInterval () const
 Returns the vertical sync interval. More...
 
bool isClosed (void) const
 Indicates whether the window has been closed by the user. More...
 
bool isHidden (void) const
 Indicates whether the window was set to hidden (not displayed) More...
 
bool isVisible (void) const
 Indicates whether the window is visible (not minimized or obscured) More...
 
bool isVSyncEnabled () const
 Indicates whether vertical sync is activated for the window. More...
 
bool requiresTextureFlipping () const
 
void setVisible (bool visible)
 Set the visibility state. More...
 
void setVSyncInterval (unsigned int interval)
 Set the vertical sync interval. More...
 
- Public Member Functions inherited from Ogre::RenderWindow
 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 bool isActive (void) const
 Overridden from RenderTarget, flags invisible windows as inactive. 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 isPrimary (void) const
 Indicates whether the window is the primary 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 setVSyncEnabled (bool vsync)
 Enable or disable vertical sync for the RenderWindow. 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)
 
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...
 
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...
 
- Public Member Functions inherited from Ogre::GLRenderTarget
virtual ~GLRenderTarget ()
 
virtual GLFrameBufferObjectCommongetFBO ()
 

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
}
 

Constructor & Destructor Documentation

◆ GLWindow()

Ogre::GLWindow::GLWindow ( )

Member Function Documentation

◆ isClosed()

bool Ogre::GLWindow::isClosed ( void  ) const
inlinevirtual

Indicates whether the window has been closed by the user.

Implements Ogre::RenderWindow.

◆ isVisible()

bool Ogre::GLWindow::isVisible ( void  ) const
inlinevirtual

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

Reimplemented from Ogre::RenderWindow.

◆ setVisible()

void Ogre::GLWindow::setVisible ( bool  visible)
inlinevirtual

Set the visibility state.

Reimplemented from Ogre::RenderWindow.

◆ isHidden()

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

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

Reimplemented from Ogre::RenderWindow.

◆ isVSyncEnabled()

bool Ogre::GLWindow::isVSyncEnabled ( ) const
inlinevirtual

Indicates whether vertical sync is activated for the window.

Reimplemented from Ogre::RenderWindow.

◆ setVSyncInterval()

void Ogre::GLWindow::setVSyncInterval ( unsigned int  interval)
virtual

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 from Ogre::RenderWindow.

◆ getVSyncInterval()

unsigned int Ogre::GLWindow::getVSyncInterval ( ) const
inlinevirtual

Returns the vertical sync interval.

Reimplemented from Ogre::RenderWindow.

◆ copyContentsToMemory()

void Ogre::GLWindow::copyContentsToMemory ( const Box src,
const PixelBox dst,
FrameBuffer  buffer 
)
virtual

Copies the current contents of the render target to a pixelbox.

Remarks
See suggestPixelFormat for a tip as to the best pixel format to extract into, although you can use whatever format you like and the results will be converted.

Implements Ogre::RenderTarget.

◆ requiresTextureFlipping()

bool Ogre::GLWindow::requiresTextureFlipping ( ) const
inlinevirtual

Implements Ogre::RenderTarget.

◆ getContext()

GLContext* Ogre::GLWindow::getContext ( ) const
inlinevirtual

Get the GL context that needs to be active to render to this target.

Implements Ogre::GLRenderTarget.


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