| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Public Types | Public Member Functions | List of all members
Ogre::D3D11RenderWindowSwapChainBased Class Referenceabstract

`#include <OgreD3D11RenderWindow.h>`

Inheritance diagram for Ogre::D3D11RenderWindowSwapChainBased:
[legend]

## Public Types
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 Member Functions
| D3D11RenderWindowSwapChainBased (D3D11Device &device)
| ~D3D11RenderWindowSwapChainBased ()
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...
IDXGISwapChainN * | _getSwapChain ()
| Get the swapchain details. More...
DXGI_SWAP_CHAIN_DESC_N * | _getSwapChainDescription (void)
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 bool | _shouldRebindBackBuffer ()
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...
void | _validateStereo ()
| Validate the type of stereo that is enabled for this window. More...
virtual void | addListener (RenderTargetListener *listener)
| Add a listener to this RenderTarget which will be called back before & after rendering. More...
virtual Viewport * | addViewport (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)
| Overridden - see RenderTarget. 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 | create (const String &name, unsigned widthPt, unsigned heightPt, bool fullScreen, const NameValuePairList *miscParams)
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)
| Destroys the window. More...
virtual void | detachDepthBuffer ()
virtual uint32 | getColourDepth (void) const
void | getCustomAttribute (const String &name, void *pData)
| Gets a custom (maybe platform-specific) attribute. More...
DepthBuffer * | getDepthBuffer () const
uint16 | getDepthBufferPool () const
virtual uint | getFSAA () const
| Indicates whether multisampling is performed on rendering and at what level. More...
virtual const String & | getFSAAHint () 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 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 void | getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
| Retrieve information about the render target. More...
virtual const String & | getName (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 FrameStats & | getStatistics (void) const
| Retieves details of current rendering performance. 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 Viewport * | getViewport (unsigned short index)
| Retrieves a pointer to the viewport with the given index. More...
virtual Viewport * | getViewportByZOrder (int ZOrder)
| Retrieves a pointer to the viewport with the given Z-order. More...
unsigned | getVSyncInterval () const
| Returns the vertical sync interval. 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 | isActive (void) const
| Overridden from RenderTarget, flags invisible windows as inactive. 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...
bool | isClosed () const
| 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 | isHardwareGammaEnabled () const
| Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. More...
bool | isHidden () 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 | isStereoEnabled (void) const
| Indicates whether stereo is currently enabled for this target. More...
virtual 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...
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 | reposition (int left, int top)
| Reposition the window. More...
bool | requiresTextureFlipping () const
void | resetStatistics (void)
| Resets saved frame-rate statistices. More...
void | resize (unsigned int width, unsigned int height)
| Alter the size of the window. 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 | setDeactivateOnFocusChange (bool deactivate)
| Indicates whether the window will automatically deactivate itself when it loses focus. 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 | 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 | setPriority (uchar priority)
| Sets the priority of this render target in relation to the others. More...
virtual void | setVisible (bool visible)
| Set the visibility state. More...
void | setVSyncEnabled (bool vsync)
| Enable or disable vertical sync for the RenderWindow. More...
void | setVSyncInterval (unsigned interval)
virtual void | setVSyncInterval (unsigned int interval)
| Set the vertical sync interval. More...
PixelFormat | suggestPixelFormat () const
| Override since windows don't usually have alpha. More...
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 | updateStats (void)
virtual void | windowMovedOrResized ()
| Notify that the window has been resized. 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...

## Member Enumeration Documentation

## ◆ StatFlags

enum Ogre::RenderTarget::StatFlags
| inherited

Enumerator
SF_NONE |
SF_FPS |
SF_AVG_FPS |
SF_BEST_FPS |
SF_WORST_FPS |
SF_TRIANGLE_COUNT |
SF_ALL |

## ◆ FrameBuffer

enum Ogre::RenderTarget::FrameBuffer
| inherited

Enumerator
FB_FRONT |
FB_BACK |
FB_AUTO |

## Constructor & Destructor Documentation

## ◆ D3D11RenderWindowSwapChainBased()

Ogre::D3D11RenderWindowSwapChainBased::D3D11RenderWindowSwapChainBased | ( | D3D11Device & | device | ) |

## ◆ ~D3D11RenderWindowSwapChainBased()

Ogre::D3D11RenderWindowSwapChainBased::~D3D11RenderWindowSwapChainBased | ( |  | ) |
| inline

## Member Function Documentation

## ◆ destroy()

virtual void Ogre::D3D11RenderWindowSwapChainBased::destroy | ( | void |  | ) |
| virtual

Destroys the window.

Reimplemented from Ogre::D3D11RenderWindowBase.

## ◆ _getSwapChain()

IDXGISwapChainN* Ogre::D3D11RenderWindowSwapChainBased::_getSwapChain | ( |  | ) |
| inline

Get the swapchain details.

## ◆ _getSwapChainDescription()

DXGI_SWAP_CHAIN_DESC_N* Ogre::D3D11RenderWindowSwapChainBased::_getSwapChainDescription | ( | void |  | ) |
| inline

## ◆ _shouldRebindBackBuffer()

virtual bool Ogre::D3D11RenderWindowSwapChainBased::_shouldRebindBackBuffer | ( |  | ) |
| inline virtual

Reimplemented from Ogre::D3D11RenderWindowBase.

## ◆ setFSAA()

virtual void Ogre::D3D11RenderWindowSwapChainBased::setFSAA | ( | uint | fsaa,
|  | const String & | fsaaHint
| ) |  |
| inline virtual

Set the level of multisample AA 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

  fsaa | The number of samples
  fsaaHint | Any hinting text (

See also
  Root::createRenderWindow)

Reimplemented from Ogre::D3D11RenderWindowBase.

## ◆ setVSyncEnabled()

void Ogre::D3D11RenderWindowSwapChainBased::setVSyncEnabled | ( | bool | vsync | ) |
| inline virtual

Enable or disable vertical sync for the RenderWindow.

Reimplemented from Ogre::RenderWindow.

## ◆ isVSyncEnabled()

bool Ogre::D3D11RenderWindowSwapChainBased::isVSyncEnabled | ( |  | ) | const
| inline virtual

Indicates whether vertical sync is activated for the window.

Reimplemented from Ogre::RenderWindow.

## ◆ setVSyncInterval() [1/2]

void Ogre::D3D11RenderWindowSwapChainBased::setVSyncInterval | ( | unsigned | interval | ) |
| inline

## ◆ getVSyncInterval()

unsigned Ogre::D3D11RenderWindowSwapChainBased::getVSyncInterval | ( |  | ) | const
| inline virtual

Returns the vertical sync interval.

Reimplemented from Ogre::RenderWindow.

## ◆ swapBuffers()

void Ogre::D3D11RenderWindowSwapChainBased::swapBuffers | ( |  | ) |
| 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.

## ◆ updateStats()

void Ogre::D3D11RenderWindowSwapChainBased::updateStats | ( | void |  | ) |
| virtual

Reimplemented from Ogre::RenderTarget.

## ◆ create() [1/2]

virtual void Ogre::D3D11RenderWindowBase::create | ( | const String & | name,
|  | unsigned | widthPt,
|  | unsigned | heightPt,
|  | bool | fullScreen,
|  | const NameValuePairList * | miscParams
| ) |  |
| virtual inherited

## ◆ create() [2/2]

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

Creates & displays the new window.

Parameters

  widthPt | The width of the window in view points.
  heightPt | The height of the window in view points.
  fullScreen | If true, the window fills the screen, with no title bar or border.
  miscParams | A variable number of pointers to platform-specific arguments. The actual requirements must be defined by the implementing subclasses.

Implemented in Ogre::D3D9RenderWindow.

## ◆ reposition()

void Ogre::D3D11RenderWindowBase::reposition | ( | int | leftPt,
|  | int | topPt
| ) |  |
| inline virtual inherited

Reposition the window.

Implements Ogre::RenderWindow.

## ◆ resize()

void Ogre::D3D11RenderWindowBase::resize | ( | unsigned int | widthPt,
|  | unsigned int | heightPt
| ) |  |
| inline virtual inherited

Alter the size of the window.

Implements Ogre::RenderWindow.

## ◆ isClosed()

bool Ogre::D3D11RenderWindowBase::isClosed | ( |  | ) | const
| inline virtual inherited

Indicates whether the window has been closed by the user.

Implements Ogre::RenderWindow.

## ◆ isHidden()

bool Ogre::D3D11RenderWindowBase::isHidden | ( | void |  | ) | const
| inline virtual inherited

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

Reimplemented from Ogre::RenderWindow.

## ◆ getCustomAttribute()

void Ogre::D3D11RenderWindowBase::getCustomAttribute | ( | const String & | name,
|  | void * | pData
| ) |  |
| virtual inherited

Gets a custom (maybe platform-specific) attribute.

Remarks
  This is a nasty way of satisfying any API's need to see platform-specific details. It horrid, but D3D needs this kind of info. At least it's abstracted.

Parameters

  name | The name of the attribute.
  pData | Pointer to memory of the right kind of structure to receive the info.

Reimplemented from Ogre::RenderTarget.

## ◆ copyContentsToMemory() [1/2]

virtual void Ogre::D3D11RenderWindowBase::copyContentsToMemory | ( | const Box & | src,
|  | const PixelBox & | dst,
|  | FrameBuffer | buffer
| ) |  |
| virtual inherited

Overridden - see RenderTarget.

Implements Ogre::RenderTarget.

## ◆ copyContentsToMemory() [2/2]

void Ogre::RenderTarget::copyContentsToMemory | ( | const PixelBox & | dst,
|  | FrameBuffer | buffer = `FB_AUTO`
| ) |  |
| inline inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:
  This function is deprecated as behavior for dst.size < RenderTarget.size was inconsistent in previous versions of Ogre.

Sometimes the whole rect was used as a source, sometimes the rect with the size equal to the size of destination rect but located in the top left corner of the render target, sometimes the destination rect itself. Use the overload with explicitly specified source and destination boxes instead.

References Ogre::RenderTarget::copyContentsToMemory().

Referenced by Ogre::RenderTarget::copyContentsToMemory().

## ◆ requiresTextureFlipping()

bool Ogre::D3D11RenderWindowBase::requiresTextureFlipping | ( |  | ) | const
| inline virtual inherited

Implements Ogre::RenderTarget.

## ◆ _validateStereo()

void Ogre::D3D11RenderWindowBase::_validateStereo | ( |  | ) |
| inherited

Validate the type of stereo that is enabled for this window.

## ◆ getViewPointToPixelScale()

virtual float Ogre::RenderWindow::getViewPointToPixelScale | ( |  | ) |
| inline virtual inherited

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.

## ◆ setFullscreen()

virtual void Ogre::RenderWindow::setFullscreen | ( | bool | fullScreen,
|  | unsigned int | widthPt,
|  | unsigned int | heightPt
| ) |  |
| inline virtual inherited

Alter fullscreen mode options.

Note
  Nothing will happen unless the settings here are different from the current settings.

Parameters

  fullScreen | Whether to use fullscreen mode or not.
  widthPt | The new width to use
  heightPt | The new height to use

Reimplemented in Ogre::D3D9RenderWindow.

## ◆ windowMovedOrResized()

virtual void Ogre::RenderWindow::windowMovedOrResized | ( |  | ) |
| inline virtual inherited

Notify that the window has been resized.

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

Reimplemented in Ogre::D3D9RenderWindow.

## ◆ isVisible()

virtual bool Ogre::RenderWindow::isVisible | ( | void |  | ) | const
| inline virtual inherited

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

Reimplemented in Ogre::D3D9RenderWindow.

## ◆ setVisible()

virtual void Ogre::RenderWindow::setVisible | ( | bool | visible | ) |
| inline virtual inherited

Set the visibility state.

## ◆ setHidden()

virtual void Ogre::RenderWindow::setHidden | ( | bool | hidden | ) |
| inline virtual inherited

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.

## ◆ setVSyncInterval() [2/2]

virtual void Ogre::RenderWindow::setVSyncInterval | ( | unsigned int | interval | ) |
| inline virtual inherited

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.

## ◆ isActive()

virtual bool Ogre::RenderWindow::isActive | ( | void |  | ) | const
| inline virtual inherited

Overridden from RenderTarget, flags invisible windows as inactive.

Reimplemented from Ogre::RenderTarget.

Reimplemented in Ogre::D3D9RenderWindow.

## ◆ isPrimary()

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

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 inherited

Returns true if window is running in fullscreen mode.

## ◆ getMetrics() [1/3]

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

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

Result is in pixels.

## ◆ getMetrics() [2/3]

virtual void Ogre::RenderTarget::getMetrics
| inherited

Retrieve information about the render target.

## ◆ getMetrics() [3/3]

virtual void Ogre::RenderTarget::getMetrics | ( | unsigned int & | width,
|  | unsigned int & | height,
|  | unsigned int & | colourDepth
| ) |  |
| virtual inherited

Retrieve information about the render target.

## ◆ suggestPixelFormat()

PixelFormat Ogre::RenderWindow::suggestPixelFormat | ( |  | ) | const
| inline virtual inherited

Override since windows don't usually have alpha.

Reimplemented from Ogre::RenderTarget.

References Ogre::PF_BYTE_RGB.

## ◆ isDeactivatedOnFocusChange()

bool Ogre::RenderWindow::isDeactivatedOnFocusChange | ( |  | ) | const
| inherited

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

## ◆ setDeactivateOnFocusChange()

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

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

Parameters

  deactivate | a 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.

## ◆ getName()

virtual const String& Ogre::RenderTarget::getName | ( | void |  | ) | const
| virtual inherited

Retrieve target's name.

## ◆ getWidth()

virtual uint32 Ogre::RenderTarget::getWidth | ( | void |  | ) | const
| virtual inherited

## ◆ getHeight()

virtual uint32 Ogre::RenderTarget::getHeight | ( | void |  | ) | const
| virtual inherited

## ◆ getColourDepth()

virtual uint32 Ogre::RenderTarget::getColourDepth | ( | void |  | ) | const
| virtual inherited

## ◆ setDepthBufferPool()

void Ogre::RenderTarget::setDepthBufferPool | ( | uint16 | poolId | ) |
| inherited

Sets the pool ID this RenderTarget should query from.

Default value is POOL_DEFAULT. Set to POOL_NO_DEPTH to avoid using a DepthBuffer (or manually controlling it)

See also
  DepthBuffer

Remarks
  Changing the pool Id will cause the current depth buffer to be detached unless the old id and the new one are the same

## ◆ getDepthBufferPool()

uint16 Ogre::RenderTarget::getDepthBufferPool | ( |  | ) | const
| inherited

## ◆ getDepthBuffer()

DepthBuffer* Ogre::RenderTarget::getDepthBuffer | ( |  | ) | const
| inherited

## ◆ attachDepthBuffer()

virtual bool Ogre::RenderTarget::attachDepthBuffer | ( | DepthBuffer * | depthBuffer | ) |
| virtual inherited

Reimplemented in Ogre::GLFBORenderTexture, Ogre::GL3PlusFBORenderTexture, Ogre::GLES2FBORenderTexture, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

## ◆ detachDepthBuffer()

virtual void Ogre::RenderTarget::detachDepthBuffer | ( |  | ) |
| virtual inherited

Reimplemented in Ogre::GLFBORenderTexture, Ogre::GL3PlusFBORenderTexture, Ogre::GLES2FBORenderTexture, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

## ◆ _detachDepthBuffer()

virtual void Ogre::RenderTarget::_detachDepthBuffer | ( |  | ) |
| virtual inherited

Detaches DepthBuffer without notifying it from the detach.

Useful when called from the DepthBuffer while it iterates through attached RenderTargets (

See also
  DepthBuffer::_setPoolId())

Reimplemented in Ogre::GLFBORenderTexture, Ogre::GL3PlusFBORenderTexture, Ogre::GLES2FBORenderTexture, Ogre::GL3PlusFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

## ◆ update()

virtual void Ogre::RenderTarget::update | ( | bool | swapBuffers = `true` | ) |
| virtual inherited

Tells the target to update it's contents.

Remarks
  If OGRE is not running in an automatic rendering loop (started using Root::startRendering), the user of the library is responsible for asking each render target to refresh. This is the method used to do this. It automatically re-renders the contents of the target using whatever cameras have been pointed at it (using Camera::setRenderTarget).

  This allows OGRE to be used in multi-windowed utilities and for contents to be refreshed only when required, rather than constantly as with the automatic rendering loop.

Parameters

  swapBuffers | For targets that support double-buffering, if set to true, the target will immediately swap it's buffers after update. Otherwise, the buffers are not swapped, and you have to call swapBuffers yourself sometime later. You might want to do this on some rendersystems which pause for queued rendering commands to complete before accepting swap buffers calls - so you could do other CPU tasks whilst the queued commands complete. Or, you might do this if you want custom control over your windows, such as for externally created windows.

Reimplemented in Ogre::D3D9RenderTexture, and Ogre::D3D9MultiRenderTarget.

## ◆ addViewport()

virtual Viewport* Ogre::RenderTarget::addViewport | ( | Camera * | cam,
|  | int | ZOrder = `0`,
|  | float | left = `0.0f`,
|  | float | top = `0.0f`,
|  | float | width = `1.0f`,
|  | float | height = `1.0f`
| ) |  |
| virtual inherited

Adds a viewport to the rendering target.

Remarks
  A viewport is the rectangle into which rendering output is sent. This method adds a viewport to the render target, rendering from the supplied camera. The rest of the parameters are only required if you wish to add more than one viewport to a single rendering target. Note that size information passed to this method is passed as a parametric, i.e. it is relative rather than absolute. This is to allow viewports to automatically resize along with the target.

Parameters

  cam | The camera from which the viewport contents will be rendered (mandatory)
  ZOrder | The relative order of the viewport with others on the target (allows overlapping viewports i.e. picture-in-picture). Higher Z-orders are on top of lower ones. The actual number is irrelevant, only the relative Z-order matters (you can leave gaps in the numbering)
  left | The relative position of the left of the viewport on the target, as a value between 0 and 1.
  top | The relative position of the top of the viewport on the target, as a value between 0 and 1.
  width | The relative width of the viewport on the target, as a value between 0 and 1.
  height | The relative height of the viewport on the target, as a value between 0 and 1.

## ◆ getNumViewports()

virtual unsigned short Ogre::RenderTarget::getNumViewports | ( | void |  | ) | const
| virtual inherited

Returns the number of viewports attached to this target.

## ◆ getViewport()

virtual Viewport* Ogre::RenderTarget::getViewport | ( | unsigned short | index | ) |
| virtual inherited

Retrieves a pointer to the viewport with the given index.

## ◆ getViewportByZOrder()

virtual Viewport* Ogre::RenderTarget::getViewportByZOrder | ( | int | ZOrder | ) |
| virtual inherited

Retrieves a pointer to the viewport with the given Z-order.

Remarks
  throws if not found.

## ◆ hasViewportWithZOrder()

virtual bool Ogre::RenderTarget::hasViewportWithZOrder | ( | int | ZOrder | ) |
| virtual inherited

Returns true if and only if a viewport exists at the given Z-order.

## ◆ removeViewport()

virtual void Ogre::RenderTarget::removeViewport | ( | int | ZOrder | ) |
| virtual inherited

Removes a viewport at a given Z-order.

## ◆ removeAllViewports()

virtual void Ogre::RenderTarget::removeAllViewports | ( | void |  | ) |
| virtual inherited

Removes all viewports on this target.

## ◆ getStatistics()

const FrameStats& Ogre::RenderTarget::getStatistics | ( | void |  | ) | const
| inline inherited

Retieves details of current rendering performance.

## ◆ resetStatistics()

void Ogre::RenderTarget::resetStatistics | ( | void |  | ) |
| inherited

Resets saved frame-rate statistices.

## ◆ addListener()

virtual void Ogre::RenderTarget::addListener | ( | RenderTargetListener * | listener | ) |
| virtual inherited

Add a listener to this RenderTarget which will be called back before & after rendering.

Remarks
  If you want notifications before and after a target is updated by the system, use this method to register your own custom RenderTargetListener class. This is useful for potentially adding your own manual rendering commands before and after the 'normal' system rendering.

NB this should not be used for frame-based scene updates, use Root::addFrameListener for that.

## ◆ insertListener()

virtual void Ogre::RenderTarget::insertListener | ( | RenderTargetListener * | listener,
|  | const unsigned int | pos = `0`
| ) |  |
| virtual inherited

same as addListener, but force the position in the vector, so we can control the call order

## ◆ removeListener()

virtual void Ogre::RenderTarget::removeListener | ( | RenderTargetListener * | listener | ) |
| virtual inherited

Removes a RenderTargetListener previously registered using addListener.

## ◆ removeAllListeners()

virtual void Ogre::RenderTarget::removeAllListeners | ( | void |  | ) |
| virtual inherited

Removes all listeners from this instance.

## ◆ setPriority()

virtual void Ogre::RenderTarget::setPriority | ( | uchar | priority | ) |
| inline virtual inherited

Sets the priority of this render target in relation to the others.

Remarks
  This can be used in order to schedule render target updates. Lower priorities will be rendered first. Note that the priority must be set at the time the render target is attached to the render system, changes afterwards will not affect the ordering.

## ◆ getPriority()

virtual uchar Ogre::RenderTarget::getPriority | ( |  | ) | const
| inline virtual inherited

Gets the priority of a render target.

## ◆ setActive()

virtual void Ogre::RenderTarget::setActive | ( | bool | state | ) |
| virtual inherited

Used to set the active state of the render target.

## ◆ setAutoUpdated()

virtual void Ogre::RenderTarget::setAutoUpdated | ( | bool | autoupdate | ) |
| virtual inherited

Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

Remarks
  By default, if you use Ogre's own rendering loop (Root::startRendering) or call Root::_updateAllRenderTargets, all render targets are updated automatically. This method allows you to control that behaviour, if for example you have a render target which you only want to update periodically.

Parameters

  autoupdate | If true, the render target is updated during the automatic render loop or when Root::_updateAllRenderTargets is called. If false, the target is only updated when its update() method is called explicitly.

## ◆ isAutoUpdated()

virtual bool Ogre::RenderTarget::isAutoUpdated | ( | void |  | ) | const
| virtual inherited

Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used.

## ◆ writeContentsToFile()

void Ogre::RenderTarget::writeContentsToFile | ( | const String & | filename | ) |
| inherited

Writes the current contents of the render target to the named file.

## ◆ writeContentsToTimestampedFile()

virtual String Ogre::RenderTarget::writeContentsToTimestampedFile | ( | const String & | filenamePrefix,
|  | const String & | filenameSuffix
| ) |  |
| virtual inherited

Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file.

Returns
  the name of the file used.

## ◆ _notifyCameraRemoved()

virtual void Ogre::RenderTarget::_notifyCameraRemoved | ( | const Camera * | cam | ) |
| virtual inherited

Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer.

## ◆ isStereoEnabled()

virtual bool Ogre::RenderTarget::isStereoEnabled | ( | void |  | ) | const
| virtual inherited

Indicates whether stereo is currently enabled for this target.

Default is false.

## ◆ isHardwareGammaEnabled()

virtual bool Ogre::RenderTarget::isHardwareGammaEnabled | ( |  | ) | const
| inline virtual inherited

Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space.

This is the exact opposite conversion of what is indicated by Texture::isHardwareGammaEnabled, and can only be enabled on creation of the render target. For render windows, it's enabled through the 'gamma' creation misc parameter. For textures, it is enabled through the hwGamma parameter to the create call.

## ◆ getFSAA()

virtual uint Ogre::RenderTarget::getFSAA | ( |  | ) | const
| inline virtual inherited

Indicates whether multisampling is performed on rendering and at what level.

## ◆ getFSAAHint()

virtual const String& Ogre::RenderTarget::getFSAAHint | ( |  | ) | const
| inline virtual inherited

Gets the FSAA hint (.

See also
  Root::createRenderWindow)

## ◆ _getImpl()

virtual Impl* Ogre::RenderTarget::_getImpl | ( |  | ) |
| virtual inherited

Get rendersystem specific interface for this RenderTarget.

This is used by the RenderSystem to (un)bind this target, and to get specific information like surfaces and framebuffer objects.

## ◆ _beginUpdate()

virtual void Ogre::RenderTarget::_beginUpdate | ( |  | ) |
| virtual inherited

Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc.

Remarks
  - _beginUpdate resets statistics and fires 'preRenderTargetUpdate'.
  - _updateViewport renders the given viewport (even if it is not autoupdated), fires preViewportUpdate and postViewportUpdate and manages statistics.
  - _updateAutoUpdatedViewports renders only viewports that are auto updated, fires preViewportUpdate and postViewportUpdate and manages statistics.
  - _endUpdate() ends statistics calculation and fires postRenderTargetUpdate.
  you can use it like this for example :

          renderTarget->_beginUpdate();
          renderTarget->_updateViewport(1); // which is not auto updated
          renderTarget->_updateViewport(2); // which is not auto updated
          renderTarget->_updateAutoUpdatedViewports();
          renderTarget->_endUpdate();
          renderTarget->swapBuffers();

  Please note that in that case, the zorder may not work as you expect, since you are responsible for calling _updateViewport in the correct order.

Reimplemented in Ogre::D3D9RenderWindow.

## ◆ _updateViewport() [1/2]

virtual void Ogre::RenderTarget::_updateViewport | ( | int | zorder,
|  | bool | updateStatistics = `true`
| ) |  |
| virtual inherited

Method for manual management of rendering - renders the given viewport (even if it is not autoupdated)

Remarks
  This also fires preViewportUpdate and postViewportUpdate, and manages statistics. You should call it between _beginUpdate() and _endUpdate().

See also
  _beginUpdate for more details.

Parameters

  zorder | The zorder of the viewport to update.
  updateStatistics | Whether you want to update statistics or not.

## ◆ _updateViewport() [2/2]

virtual void Ogre::RenderTarget::_updateViewport | ( | Viewport * | viewport,
|  | bool | updateStatistics = `true`
| ) |  |
| virtual inherited

Method for manual management of rendering - renders the given viewport (even if it is not autoupdated)

Remarks
  This also fires preViewportUpdate and postViewportUpdate, and manages statistics if needed. You should call it between _beginUpdate() and _endUpdate().

See also
  _beginUpdate for more details.

Parameters

  viewport | The viewport you want to update, it must be bound to the rendertarget.
  updateStatistics | Whether you want to update statistics or not.

Reimplemented in Ogre::D3D9RenderWindow.

## ◆ _updateAutoUpdatedViewports()

virtual void Ogre::RenderTarget::_updateAutoUpdatedViewports | ( | bool | updateStatistics = `true` | ) |
| virtual inherited

Method for manual management of rendering - renders only viewports that are auto updated.

Remarks
  This also fires preViewportUpdate and postViewportUpdate, and manages statistics. You should call it between _beginUpdate() and _endUpdate(). See _beginUpdate for more details.

Parameters

  updateStatistics | Whether you want to update statistics or not.

See also
  _beginUpdate()

## ◆ _endUpdate()

virtual void Ogre::RenderTarget::_endUpdate | ( |  | ) |
| virtual inherited

Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'.

Remarks
  You should call it after a _beginUpdate

See also
  _beginUpdate for more details.

Reimplemented in Ogre::D3D9RenderWindow.

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

- OgreD3D11RenderWindow.h