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

#include <OgreMetalRenderWindow.h>

+ Inheritance diagram for Ogre::MetalRenderWindow:

Public Member Functions

 MetalRenderWindow (MetalDevice *ownerDevice, MetalRenderSystem *renderSystem)
 
virtual ~MetalRenderWindow ()
 
virtual void copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer)
 Copies the current contents of the render target to a pixelbox. More...
 
virtual void create (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams)
 Creates & displays the new window. More...
 
virtual void destroy (void)
 Destroys the window. More...
 
virtual void getCustomAttribute (const String &name, void *pData)
 Retrieve a platform or API-specific piece of information. More...
 
float getViewPointToPixelScale () override
 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 isClosed (void) const
 Indicates whether the window has been closed by the user. More...
 
virtual bool nextDrawable (void)
 Returns true on success. False on failure. More...
 
virtual void reposition (int left, int top)
 Reposition the window. More...
 
virtual bool requiresTextureFlipping () const
 
virtual void resize (unsigned int width, unsigned int height)
 Alter the size of the window. More...
 
PixelFormat suggestPixelFormat () const override
 Override since windows don't usually have alpha. More...
 
virtual void swapBuffers (void)
 Swaps the frame buffers to display the next frame. More...
 
virtual void windowMovedOrResized (void)
 Notify that the window has been resized. More...
 
- Public Member Functions inherited from Ogre::RenderWindow
 RenderWindow ()
 Default constructor. 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 unsigned int getVSyncInterval () const
 Returns the vertical sync interval. 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 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...
 
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...
 
- 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...
 
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 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::MetalRenderTargetCommon
 MetalRenderTargetCommon (MetalDevice *ownerDevice)
 
 ~MetalRenderTargetCommon ()
 
void destroy (void)
 
MetalDevicegetOwnerDevice (void) const
 
void init (id< MTLTexture > texture, id< MTLTexture > resolveTexture)
 

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
}
 
- Public Attributes inherited from Ogre::MetalRenderTargetCommon
MTLRenderPassColorAttachmentDescriptor * mColourAttachmentDesc
 

Constructor & Destructor Documentation

◆ MetalRenderWindow()

Ogre::MetalRenderWindow::MetalRenderWindow ( MetalDevice ownerDevice,
MetalRenderSystem renderSystem 
)

◆ ~MetalRenderWindow()

virtual Ogre::MetalRenderWindow::~MetalRenderWindow ( )
virtual

Member Function Documentation

◆ swapBuffers()

virtual void Ogre::MetalRenderWindow::swapBuffers ( void  )
virtual

Swaps the frame buffers to display the next frame.

Remarks
For targets that are double-buffered so that no 'in-progress' versions of the scene are displayed during rendering. Once rendering has completed (to an off-screen version of the window) the buffers are swapped to display the new frame.

Reimplemented from Ogre::RenderTarget.

◆ windowMovedOrResized()

virtual void Ogre::MetalRenderWindow::windowMovedOrResized ( void  )
virtual

Notify that the window has been resized.

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

Reimplemented from Ogre::RenderWindow.

◆ nextDrawable()

virtual bool Ogre::MetalRenderWindow::nextDrawable ( void  )
virtual

Returns true on success. False on failure.

Reimplemented from Ogre::MetalRenderTargetCommon.

◆ create()

virtual void Ogre::MetalRenderWindow::create ( const String name,
unsigned int  widthPt,
unsigned int  heightPt,
bool  fullScreen,
const NameValuePairList miscParams 
)
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.

Implements Ogre::RenderWindow.

◆ destroy()

virtual void Ogre::MetalRenderWindow::destroy ( void  )
virtual

Destroys the window.

Implements Ogre::RenderWindow.

◆ resize()

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

Alter the size of the window.

Implements Ogre::RenderWindow.

◆ reposition()

virtual void Ogre::MetalRenderWindow::reposition ( int  leftPt,
int  topPt 
)
virtual

Reposition the window.

Implements Ogre::RenderWindow.

◆ isClosed()

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

Indicates whether the window has been closed by the user.

Implements Ogre::RenderWindow.

◆ copyContentsToMemory()

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

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

virtual bool Ogre::MetalRenderWindow::requiresTextureFlipping ( ) const
inlinevirtual

Implements Ogre::RenderTarget.

◆ getCustomAttribute()

virtual void Ogre::MetalRenderWindow::getCustomAttribute ( const String name,
void *  pData 
)
virtual

Retrieve a platform or API-specific piece of information.

This method of retrieving information should only be used if you know what you're doing.

Name Description
WINDOW The native window handle. (X11 Window XID/ HWND / NSWindow*)
HWND deprecated (same as WINDOW)
GL_FBOID the id of the OpenGL framebuffer object
GL_MULTISAMPLEFBOID the id of the OpenGL framebuffer object used for multisampling
GLFBO id of the screen OpenGL framebuffer object on iOS
GLCONTEXT deprecated, do not use
FBO deprecated, do not use
TARGET deprecated, do not use
XDISPLAY 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.
VIEW Cocoa NSView*
NSOPENGLCONTEXT Cocoa NSOpenGLContext*
NSOPENGLPIXELFORMAT Cocoa NSOpenGLPixelFormat*
Parameters
nameThe name of the attribute.
pDataPointer to memory of the right kind of structure to receive the info.

Reimplemented from Ogre::RenderTarget.

◆ suggestPixelFormat()

PixelFormat Ogre::MetalRenderWindow::suggestPixelFormat ( ) const
inlineoverridevirtual

Override since windows don't usually have alpha.

Reimplemented from Ogre::RenderWindow.

◆ getViewPointToPixelScale()

float Ogre::MetalRenderWindow::getViewPointToPixelScale ( )
inlineoverridevirtual

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


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