OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::D3D11RenderWindowSwapChainBased Class Referenceabstract

#include <OgreD3D11RenderWindow.h>

+ Inheritance diagram for Ogre::D3D11RenderWindowSwapChainBased:
+ Collaboration diagram for Ogre::D3D11RenderWindowSwapChainBased:

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, IDXGIFactoryN *pDXGIFactory)
 
 ~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...
 
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)
 
virtual void copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer)
 Overridden - see RenderTarget. More...
 
virtual void create (const String &name, unsigned width, unsigned height, bool fullScreen, const NameValuePairList *miscParams)
 
virtual void create (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams)=0
 Creates & displays the new window. More...
 
virtual void destroy (void)
 Destroys the window. More...
 
virtual void detachDepthBuffer ()
 
virtual float getAverageFPS () const
 Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering. More...
 
virtual size_t getBatchCount (void) const
 Gets the number of batches rendered in the last update() call. More...
 
virtual float getBestFPS () const
 Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering. More...
 
virtual float getBestFrameTime () const
 Individual stats access - gets the best frame time. More...
 
virtual uint32 getColourDepth (void) const
 
void getCustomAttribute (const String &name, void *pData)
 Gets a custom (maybe platform-specific) attribute. 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 float getLastFPS () const
 Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered. 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)
 Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems. 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...
 
DXGI_SWAP_CHAIN_DESC_NgetPresentationParameters (void)
 Get the presentation parameters used with this window. More...
 
virtual uchar getPriority () const
 Gets the priority of a render target. More...
 
virtual void getStatistics (float &lastFPS, float &avgFPS, float &bestFPS, float &worstFPS) const
 Retieves details of current rendering performance. More...
 
virtual const FrameStatsgetStatistics (void) const
 
virtual size_t getTriangleCount (void) const
 Gets the number of triangles rendered in the last update() call. 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 unsigned int getVSyncInterval () const
 Returns the vertical sync interval. More...
 
virtual uint32 getWidth (void) const
 
virtual float getWorstFPS () const
 Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering. More...
 
virtual float getWorstFrameTime () const
 Individual stats access - gets the worst frame time. More...
 
virtual bool hasViewportWithZOrder (int ZOrder)
 Returns true if and only if a viewport exists at the given Z-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 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 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 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
 
virtual 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 setFullscreen (bool fullScreen, unsigned int width, unsigned int height)
 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...
 
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...
 
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...
 
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...
 

Protected Types

typedef vector
< RenderTargetListener * >
::type 
RenderTargetListenerList
 
typedef map< int, Viewport * >
::type 
ViewportList
 

Protected Member Functions

bool _checkMultiSampleQuality (UINT SampleCount, UINT *outQuality, DXGI_FORMAT format)
 
void _createSizeDependedD3DResources ()
 
void _createSwapChain ()
 
virtual HRESULT _createSwapChainImpl (IDXGIDeviceN *pDXGIDevice)=0
 
void _destroySizeDependedD3DResources ()
 
IDXGIDeviceN_queryDxgiDevice ()
 
void _resizeSwapChainBuffers (unsigned width, unsigned height)
 
void _setPrimary ()
 Indicates that this is the primary window. More...
 
void _updateViewportsDimensions ()
 
virtual void firePostUpdate (void)
 internal method for firing events More...
 
virtual void firePreUpdate (void)
 internal method for firing events More...
 
virtual void fireViewportAdded (Viewport *vp)
 internal method for firing events More...
 
virtual void fireViewportPostUpdate (Viewport *vp)
 internal method for firing events More...
 
virtual void fireViewportPreUpdate (Viewport *vp)
 internal method for firing events More...
 
virtual void fireViewportRemoved (Viewport *vp)
 internal method for firing events More...
 
virtual void updateImpl ()
 Internal implementation of update() More...
 
void updateStats (void)
 

Protected Attributes

bool mActive
 
bool mAutoDeactivatedOnFocusChange
 
bool mAutoUpdate
 
bool mClosed
 
uint32 mColourDepth
 
DepthBuffermDepthBuffer
 
uint16 mDepthBufferPoolId
 
ID3D11DepthStencilView * mDepthStencilView
 
D3D11DevicemDevice
 
UINT mDisplayFrequency
 
size_t mFrameCount
 
uint mFSAA
 
String mFSAAHint
 
DXGI_SAMPLE_DESC mFSAAType
 
uint32 mHeight
 
bool mHidden
 
bool mHwGamma
 
bool mIsExternal
 
bool mIsFullScreen
 
bool mIsPrimary
 
unsigned long mLastSecond
 
unsigned long mLastTime
 
int mLeft
 
RenderTargetListenerList mListeners
 
String mName
 The name of this target. More...
 
ID3D11Texture2D * mpBackBuffer
 
IDXGIFactoryNmpDXGIFactory
 
uchar mPriority
 The priority of the render target. More...
 
IDXGISwapChainNmpSwapChain
 
ID3D11RenderTargetView * mRenderTargetView
 
bool mSizing
 
FrameStats mStats
 
DXGI_SWAP_CHAIN_DESC_N mSwapChainDesc
 
TimermTimer
 
int mTop
 
ViewportList mViewportList
 List of viewports, map on Z-order. More...
 
bool mVSync
 
unsigned int mVSyncInterval
 
uint32 mWidth
 

Detailed Description

Definition at line 102 of file OgreD3D11RenderWindow.h.

Member Typedef Documentation

Definition at line 497 of file OgreRenderTarget.h.

typedef map<int, Viewport*>::type Ogre::RenderTarget::ViewportList
protectedinherited

Definition at line 493 of file OgreRenderTarget.h.

Member Enumeration Documentation

Enumerator
FB_FRONT 
FB_BACK 
FB_AUTO 

Definition at line 91 of file OgreRenderTarget.h.

Enumerator
SF_NONE 
SF_FPS 
SF_AVG_FPS 
SF_BEST_FPS 
SF_WORST_FPS 
SF_TRIANGLE_COUNT 
SF_ALL 

Definition at line 68 of file OgreRenderTarget.h.

Constructor & Destructor Documentation

Ogre::D3D11RenderWindowSwapChainBased::D3D11RenderWindowSwapChainBased ( D3D11Device device,
IDXGIFactoryN pDXGIFactory 
)
Ogre::D3D11RenderWindowSwapChainBased::~D3D11RenderWindowSwapChainBased ( )
inline

Definition at line 107 of file OgreD3D11RenderWindow.h.

References destroy().

Member Function Documentation

virtual void Ogre::RenderTarget::_beginUpdate ( )
virtualinherited

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, Ogre::EAGLWindow, and Ogre::EAGL2Window.

bool Ogre::D3D11RenderWindowBase::_checkMultiSampleQuality ( UINT  SampleCount,
UINT *  outQuality,
DXGI_FORMAT  format 
)
protectedinherited
void Ogre::D3D11RenderWindowSwapChainBased::_createSizeDependedD3DResources ( )
protected
void Ogre::D3D11RenderWindowSwapChainBased::_createSwapChain ( )
protected
virtual HRESULT Ogre::D3D11RenderWindowSwapChainBased::_createSwapChainImpl ( IDXGIDeviceN pDXGIDevice)
protectedpure virtual
void Ogre::D3D11RenderWindowBase::_destroySizeDependedD3DResources ( )
protectedinherited
virtual void Ogre::RenderTarget::_detachDepthBuffer ( )
virtualinherited

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::GL3PlusFBOMultiRenderTarget, Ogre::GLESFBOMultiRenderTarget, Ogre::GLES2FBOMultiRenderTarget, and Ogre::GLFBOMultiRenderTarget.

virtual void Ogre::RenderTarget::_endUpdate ( )
virtualinherited

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.

virtual Impl* Ogre::RenderTarget::_getImpl ( )
virtualinherited

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.

virtual void Ogre::RenderTarget::_notifyCameraRemoved ( const Camera cam)
virtualinherited

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

IDXGIDeviceN* Ogre::D3D11RenderWindowBase::_queryDxgiDevice ( )
protectedinherited
void Ogre::D3D11RenderWindowSwapChainBased::_resizeSwapChainBuffers ( unsigned  width,
unsigned  height 
)
protected
void Ogre::RenderWindow::_setPrimary ( )
inlineprotectedinherited

Indicates that this is the primary window.

Only to be called by Ogre::Root

Definition at line 206 of file OgreRenderWindow.h.

virtual void Ogre::RenderTarget::_updateAutoUpdatedViewports ( bool  updateStatistics = true)
virtualinherited

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
updateStatisticsWhether you want to update statistics or not.
See also
_beginUpdate()
virtual void Ogre::RenderTarget::_updateViewport ( int  zorder,
bool  updateStatistics = true 
)
virtualinherited

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
zorderThe zorder of the viewport to update.
updateStatisticsWhether you want to update statistics or not.
virtual void Ogre::RenderTarget::_updateViewport ( Viewport viewport,
bool  updateStatistics = true 
)
virtualinherited

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
viewportThe viewport you want to update, it must be bound to the rendertarget.
updateStatisticsWhether you want to update statistics or not.

Reimplemented in Ogre::D3D9RenderWindow.

void Ogre::D3D11RenderWindowBase::_updateViewportsDimensions ( )
protectedinherited
virtual void Ogre::RenderTarget::addListener ( RenderTargetListener listener)
virtualinherited

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.
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 
)
virtualinherited

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
camThe camera from which the viewport contents will be rendered (mandatory)
ZOrderThe 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)
leftThe relative position of the left of the viewport on the target, as a value between 0 and 1.
topThe relative position of the top of the viewport on the target, as a value between 0 and 1.
widthThe relative width of the viewport on the target, as a value between 0 and 1.
heightThe relative height of the viewport on the target, as a value between 0 and 1.
virtual void Ogre::D3D11RenderWindowBase::copyContentsToMemory ( const PixelBox dst,
FrameBuffer  buffer 
)
virtualinherited

Overridden - see RenderTarget.

Implements Ogre::RenderTarget.

virtual void Ogre::D3D11RenderWindowBase::create ( const String name,
unsigned  width,
unsigned  height,
bool  fullScreen,
const NameValuePairList miscParams 
)
virtualinherited
virtual void Ogre::RenderWindow::create ( const String name,
unsigned int  width,
unsigned int  height,
bool  fullScreen,
const NameValuePairList miscParams 
)
pure virtualinherited

Creates & displays the new window.

Parameters
widthThe width of the window in pixels.
heightThe height of the window in pixels.
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.

Implemented in Ogre::EAGLWindow, Ogre::EAGL2Window, Ogre::NaClWindow, Ogre::X11EGLWindow, Ogre::X11EGLWindow, Ogre::AndroidEGLWindow, Ogre::AndroidEGLWindow, Ogre::SDLWindow, Ogre::SDLWindow, Ogre::Win32EGLWindow, Ogre::Win32EGLWindow, Ogre::OSXCarbonWindow, Ogre::OSXWindow, Ogre::D3D9RenderWindow, Ogre::GLXWindow, Ogre::GLXWindow, Ogre::Win32Window, and Ogre::Win32Window.

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

Destroys the window.

Reimplemented from Ogre::D3D11RenderWindowBase.

Reimplemented in Ogre::D3D11RenderWindowCoreWindow, and Ogre::D3D11RenderWindowHwnd.

Referenced by ~D3D11RenderWindowSwapChainBased().

virtual void Ogre::RenderTarget::firePostUpdate ( void  )
protectedvirtualinherited

internal method for firing events

virtual void Ogre::RenderTarget::firePreUpdate ( void  )
protectedvirtualinherited

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportAdded ( Viewport vp)
protectedvirtualinherited

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPostUpdate ( Viewport vp)
protectedvirtualinherited

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportPreUpdate ( Viewport vp)
protectedvirtualinherited

internal method for firing events

virtual void Ogre::RenderTarget::fireViewportRemoved ( Viewport vp)
protectedvirtualinherited

internal method for firing events

virtual float Ogre::RenderTarget::getAverageFPS ( ) const
virtualinherited

Individual stats access - gets the average frames per second (FPS) since call to Root::startRendering.

virtual size_t Ogre::RenderTarget::getBatchCount ( void  ) const
virtualinherited

Gets the number of batches rendered in the last update() call.

virtual float Ogre::RenderTarget::getBestFPS ( ) const
virtualinherited

Individual stats access - gets the best frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getBestFrameTime ( ) const
virtualinherited

Individual stats access - gets the best frame time.

virtual uint32 Ogre::RenderTarget::getColourDepth ( void  ) const
virtualinherited
void Ogre::D3D11RenderWindowBase::getCustomAttribute ( const String name,
void *  pData 
)
virtualinherited

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
nameThe name of the attribute.
pDataPointer to memory of the right kind of structure to receive the info.

Reimplemented from Ogre::RenderTarget.

Reimplemented in Ogre::D3D11RenderWindowImageSource, and Ogre::D3D11RenderWindowHwnd.

DepthBuffer* Ogre::RenderTarget::getDepthBuffer ( ) const
inherited
uint16 Ogre::RenderTarget::getDepthBufferPool ( ) const
inherited
virtual uint Ogre::RenderTarget::getFSAA ( ) const
inlinevirtualinherited

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

Definition at line 378 of file OgreRenderTarget.h.

virtual const String& Ogre::RenderTarget::getFSAAHint ( ) const
inlinevirtualinherited

Gets the FSAA hint (.

See also
Root::createRenderWindow)

Definition at line 382 of file OgreRenderTarget.h.

virtual uint32 Ogre::RenderTarget::getHeight ( void  ) const
virtualinherited
virtual float Ogre::RenderTarget::getLastFPS ( ) const
virtualinherited

Individual stats access - gets the number of frames per second (FPS) based on the last frame rendered.

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

Retrieve information about the render target.

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

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

virtual const String& Ogre::RenderTarget::getName ( void  ) const
virtualinherited

Retrieve target's name.

virtual unsigned short Ogre::RenderTarget::getNumViewports ( void  ) const
virtualinherited

Returns the number of viewports attached to this target.

DXGI_SWAP_CHAIN_DESC_N* Ogre::D3D11RenderWindowSwapChainBased::getPresentationParameters ( void  )
inline

Get the presentation parameters used with this window.

Definition at line 111 of file OgreD3D11RenderWindow.h.

References mSwapChainDesc.

virtual uchar Ogre::RenderTarget::getPriority ( ) const
inlinevirtualinherited

Gets the priority of a render target.

Definition at line 302 of file OgreRenderTarget.h.

virtual void Ogre::RenderTarget::getStatistics ( float &  lastFPS,
float &  avgFPS,
float &  bestFPS,
float &  worstFPS 
) const
virtualinherited

Retieves details of current rendering performance.

Remarks
If the user application wishes to do it's own performance display, or use performance for some other means, this method allows it to retrieve the statistics.
Parameters
lastFPSPointer to a float to receive the number of frames per second (FPS) based on the last frame rendered.
avgFPSPointer to a float to receive the FPS rating based on an average of all the frames rendered since rendering began (the call to Root::startRendering).
bestFPSPointer to a float to receive the best FPS rating that has been achieved since rendering began.
worstFPSPointer to a float to receive the worst FPS rating seen so far.
virtual const FrameStats& Ogre::RenderTarget::getStatistics ( void  ) const
virtualinherited
virtual size_t Ogre::RenderTarget::getTriangleCount ( void  ) const
virtualinherited

Gets the number of triangles rendered in the last update() call.

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

Retrieves a pointer to the viewport with the given index.

virtual Viewport* Ogre::RenderTarget::getViewportByZOrder ( int  ZOrder)
virtualinherited

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

Remarks
throws if not found.
virtual unsigned int Ogre::RenderWindow::getVSyncInterval ( ) const
inlinevirtualinherited

Returns the vertical sync interval.

Reimplemented in Ogre::GLXWindow, Ogre::GLXWindow, Ogre::D3D9RenderWindow, Ogre::Win32Window, and Ogre::Win32Window.

Definition at line 154 of file OgreRenderWindow.h.

virtual uint32 Ogre::RenderTarget::getWidth ( void  ) const
virtualinherited
virtual float Ogre::RenderTarget::getWorstFPS ( ) const
virtualinherited

Individual stats access - gets the worst frames per second (FPS) since call to Root::startRendering.

virtual float Ogre::RenderTarget::getWorstFrameTime ( ) const
virtualinherited

Individual stats access - gets the worst frame time.

virtual bool Ogre::RenderTarget::hasViewportWithZOrder ( int  ZOrder)
virtualinherited

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

virtual bool Ogre::RenderWindow::isActive ( void  ) const
inlinevirtualinherited

Overridden from RenderTarget, flags invisible windows as inactive.

Reimplemented from Ogre::RenderTarget.

Reimplemented in Ogre::GTKWindow, Ogre::GTKWindow, Ogre::SDLWindow, Ogre::SDLWindow, Ogre::OSXCarbonWindow, Ogre::OSXWindow, Ogre::D3D9RenderWindow, Ogre::Win32Window, and Ogre::Win32Window.

Definition at line 159 of file OgreRenderWindow.h.

virtual bool Ogre::RenderTarget::isAutoUpdated ( void  ) const
virtualinherited

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

bool Ogre::D3D11RenderWindowBase::isClosed ( ) const
inlinevirtualinherited

Indicates whether the window has been closed by the user.

Implements Ogre::RenderWindow.

Definition at line 59 of file OgreD3D11RenderWindow.h.

References Ogre::D3D11RenderWindowBase::mClosed.

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

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

virtual bool Ogre::RenderWindow::isFullScreen ( void  ) const
virtualinherited

Returns true if window is running in fullscreen mode.

Reimplemented in Ogre::SDLWindow, and Ogre::SDLWindow.

virtual bool Ogre::RenderTarget::isHardwareGammaEnabled ( ) const
inlinevirtualinherited

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.

Definition at line 374 of file OgreRenderTarget.h.

bool Ogre::D3D11RenderWindowBase::isHidden ( void  ) const
inlinevirtualinherited

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

Reimplemented from Ogre::RenderWindow.

Definition at line 60 of file OgreD3D11RenderWindow.h.

References Ogre::D3D11RenderWindowBase::mHidden.

virtual bool Ogre::RenderWindow::isPrimary ( void  ) const
virtualinherited

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.

virtual bool Ogre::RenderWindow::isVisible ( void  ) const
inlinevirtualinherited
virtual bool Ogre::RenderWindow::isVSyncEnabled ( ) const
inlinevirtualinherited

Indicates whether vertical sync is activated for the window.

Reimplemented in Ogre::SDLWindow, Ogre::SDLWindow, Ogre::GLXWindow, Ogre::GLXWindow, Ogre::OSXCarbonWindow, Ogre::D3D9RenderWindow, Ogre::Win32Window, and Ogre::Win32Window.

Definition at line 144 of file OgreRenderWindow.h.

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

Definition at line 119 of file OgreMemoryAllocatedObject.h.

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

Definition at line 68 of file OgreMemoryAllocatedObject.h.

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

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

Definition at line 86 of file OgreMemoryAllocatedObject.h.

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::RenderTarget::removeAllListeners ( void  )
virtualinherited

Removes all listeners from this instance.

virtual void Ogre::RenderTarget::removeAllViewports ( void  )
virtualinherited

Removes all viewports on this target.

virtual void Ogre::RenderTarget::removeListener ( RenderTargetListener listener)
virtualinherited

Removes a RenderTargetListener previously registered using addListener.

virtual void Ogre::RenderTarget::removeViewport ( int  ZOrder)
virtualinherited

Removes a viewport at a given Z-order.

void Ogre::D3D11RenderWindowBase::reposition ( int  left,
int  top 
)
inlinevirtualinherited

Reposition the window.

Implements Ogre::RenderWindow.

Reimplemented in Ogre::D3D11RenderWindowHwnd.

Definition at line 56 of file OgreD3D11RenderWindow.h.

bool Ogre::D3D11RenderWindowBase::requiresTextureFlipping ( void  ) const
inlinevirtualinherited

Implements Ogre::RenderTarget.

Definition at line 66 of file OgreD3D11RenderWindow.h.

virtual void Ogre::RenderTarget::resetStatistics ( void  )
virtualinherited

Resets saved frame-rate statistices.

void Ogre::D3D11RenderWindowBase::resize ( unsigned int  width,
unsigned int  height 
)
inlinevirtualinherited

Alter the size of the window.

Implements Ogre::RenderWindow.

Reimplemented in Ogre::D3D11RenderWindowImageSource, and Ogre::D3D11RenderWindowHwnd.

Definition at line 57 of file OgreD3D11RenderWindow.h.

virtual void Ogre::RenderTarget::setActive ( bool  state)
virtualinherited

Used to set the active state of the render target.

Reimplemented in Ogre::D3D11RenderWindowHwnd, Ogre::Win32Window, and Ogre::Win32Window.

virtual void Ogre::RenderTarget::setAutoUpdated ( bool  autoupdate)
virtualinherited

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
autoupdateIf 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.
void Ogre::RenderWindow::setDeactivateOnFocusChange ( bool  deactivate)
inherited

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

Parameters
deactivatea 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.
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
virtual void Ogre::RenderWindow::setFullscreen ( bool  fullScreen,
unsigned int  width,
unsigned int  height 
)
inlinevirtualinherited

Alter fullscreen mode options.

Note
Nothing will happen unless the settings here are different from the current settings.
Parameters
fullScreenWhether to use fullscreen mode or not.
widthThe new width to use
heightThe new height to use

Reimplemented in Ogre::D3D11RenderWindowHwnd, Ogre::EAGLWindow, Ogre::EAGL2Window, Ogre::EGLWindow, Ogre::EGLWindow, Ogre::OSXCarbonWindow, Ogre::GTKWindow, Ogre::GTKWindow, Ogre::X11EGLWindow, Ogre::X11EGLWindow, Ogre::GLXWindow, Ogre::GLXWindow, Ogre::D3D9RenderWindow, Ogre::Win32Window, and Ogre::Win32Window.

Definition at line 92 of file OgreRenderWindow.h.

virtual void Ogre::RenderWindow::setHidden ( bool  hidden)
inlinevirtualinherited

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::D3D11RenderWindowHwnd, Ogre::GLXWindow, Ogre::GLXWindow, Ogre::OSXCarbonWindow, Ogre::OSXWindow, Ogre::D3D9RenderWindow, Ogre::Win32Window, and Ogre::Win32Window.

Definition at line 134 of file OgreRenderWindow.h.

virtual void Ogre::RenderTarget::setPriority ( uchar  priority)
inlinevirtualinherited

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.

Definition at line 300 of file OgreRenderTarget.h.

virtual void Ogre::RenderWindow::setVisible ( bool  visible)
inlinevirtualinherited

Set the visibility state.

Reimplemented in Ogre::EAGLWindow, Ogre::EAGL2Window, Ogre::EGLWindow, Ogre::EGLWindow, Ogre::OSXCarbonWindow, Ogre::GLXWindow, and Ogre::GLXWindow.

Definition at line 119 of file OgreRenderWindow.h.

virtual void Ogre::RenderWindow::setVSyncEnabled ( bool  vsync)
inlinevirtualinherited
virtual void Ogre::RenderWindow::setVSyncInterval ( unsigned int  interval)
inlinevirtualinherited

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::GLXWindow, Ogre::GLXWindow, Ogre::D3D9RenderWindow, Ogre::Win32Window, and Ogre::Win32Window.

Definition at line 149 of file OgreRenderWindow.h.

PixelFormat Ogre::RenderWindow::suggestPixelFormat ( ) const
inlinevirtualinherited

Override since windows don't usually have alpha.

Reimplemented from Ogre::RenderTarget.

Reimplemented in Ogre::EAGL2Window.

Definition at line 184 of file OgreRenderWindow.h.

References Ogre::PF_BYTE_RGB.

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

virtual void Ogre::RenderTarget::update ( bool  swapBuffers = true)
virtualinherited

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
swapBuffersFor 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, Ogre::D3D11RenderWindowImageSource, and Ogre::D3D9MultiRenderTarget.

virtual void Ogre::RenderTarget::updateImpl ( )
protectedvirtualinherited

Internal implementation of update()

void Ogre::RenderTarget::updateStats ( void  )
protectedinherited
virtual void Ogre::RenderWindow::windowMovedOrResized ( void  )
inlinevirtualinherited
void Ogre::RenderTarget::writeContentsToFile ( const String filename)
inherited

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

virtual String Ogre::RenderTarget::writeContentsToTimestampedFile ( const String filenamePrefix,
const String filenameSuffix 
)
virtualinherited

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

Returns
the name of the file used.

Member Data Documentation

bool Ogre::RenderTarget::mActive
protectedinherited

Definition at line 483 of file OgreRenderTarget.h.

bool Ogre::RenderWindow::mAutoDeactivatedOnFocusChange
protectedinherited

Definition at line 199 of file OgreRenderWindow.h.

bool Ogre::RenderTarget::mAutoUpdate
protectedinherited

Definition at line 484 of file OgreRenderTarget.h.

bool Ogre::D3D11RenderWindowBase::mClosed
protectedinherited

Definition at line 84 of file OgreD3D11RenderWindow.h.

Referenced by Ogre::D3D11RenderWindowBase::isClosed().

uint32 Ogre::RenderTarget::mColourDepth
protectedinherited

Definition at line 471 of file OgreRenderTarget.h.

DepthBuffer* Ogre::RenderTarget::mDepthBuffer
protectedinherited

Definition at line 473 of file OgreRenderTarget.h.

uint16 Ogre::RenderTarget::mDepthBufferPoolId
protectedinherited

Definition at line 472 of file OgreRenderTarget.h.

ID3D11DepthStencilView* Ogre::D3D11RenderWindowBase::mDepthStencilView
protectedinherited

Definition at line 98 of file OgreD3D11RenderWindow.h.

D3D11Device& Ogre::D3D11RenderWindowBase::mDevice
protectedinherited

Definition at line 80 of file OgreD3D11RenderWindow.h.

UINT Ogre::D3D11RenderWindowBase::mDisplayFrequency
protectedinherited

Definition at line 91 of file OgreD3D11RenderWindow.h.

size_t Ogre::RenderTarget::mFrameCount
protectedinherited

Definition at line 481 of file OgreRenderTarget.h.

uint Ogre::RenderTarget::mFSAA
protectedinherited

Definition at line 488 of file OgreRenderTarget.h.

String Ogre::RenderTarget::mFSAAHint
protectedinherited

Definition at line 489 of file OgreRenderTarget.h.

DXGI_SAMPLE_DESC Ogre::D3D11RenderWindowBase::mFSAAType
protectedinherited

Definition at line 90 of file OgreD3D11RenderWindow.h.

uint32 Ogre::RenderTarget::mHeight
protectedinherited

Definition at line 470 of file OgreRenderTarget.h.

bool Ogre::D3D11RenderWindowBase::mHidden
protectedinherited

Definition at line 85 of file OgreD3D11RenderWindow.h.

Referenced by Ogre::D3D11RenderWindowBase::isHidden().

bool Ogre::RenderTarget::mHwGamma
protectedinherited

Definition at line 486 of file OgreRenderTarget.h.

bool Ogre::D3D11RenderWindowBase::mIsExternal
protectedinherited

Definition at line 82 of file OgreD3D11RenderWindow.h.

bool Ogre::RenderWindow::mIsFullScreen
protectedinherited

Definition at line 197 of file OgreRenderWindow.h.

bool Ogre::RenderWindow::mIsPrimary
protectedinherited

Definition at line 198 of file OgreRenderWindow.h.

unsigned long Ogre::RenderTarget::mLastSecond
protectedinherited

Definition at line 479 of file OgreRenderTarget.h.

unsigned long Ogre::RenderTarget::mLastTime
protectedinherited

Definition at line 480 of file OgreRenderTarget.h.

int Ogre::RenderWindow::mLeft
protectedinherited

Definition at line 200 of file OgreRenderWindow.h.

RenderTargetListenerList Ogre::RenderTarget::mListeners
protectedinherited

Definition at line 498 of file OgreRenderTarget.h.

String Ogre::RenderTarget::mName
protectedinherited

The name of this target.

Definition at line 465 of file OgreRenderTarget.h.

ID3D11Texture2D* Ogre::D3D11RenderWindowBase::mpBackBuffer
protectedinherited

Definition at line 96 of file OgreD3D11RenderWindow.h.

IDXGIFactoryN* Ogre::D3D11RenderWindowBase::mpDXGIFactory
protectedinherited

Definition at line 81 of file OgreD3D11RenderWindow.h.

uchar Ogre::RenderTarget::mPriority
protectedinherited

The priority of the render target.

Definition at line 467 of file OgreRenderTarget.h.

IDXGISwapChainN* Ogre::D3D11RenderWindowSwapChainBased::mpSwapChain
protected

Definition at line 123 of file OgreD3D11RenderWindow.h.

ID3D11RenderTargetView* Ogre::D3D11RenderWindowBase::mRenderTargetView
protectedinherited

Definition at line 97 of file OgreD3D11RenderWindow.h.

bool Ogre::D3D11RenderWindowBase::mSizing
protectedinherited

Definition at line 83 of file OgreD3D11RenderWindow.h.

FrameStats Ogre::RenderTarget::mStats
protectedinherited

Definition at line 476 of file OgreRenderTarget.h.

DXGI_SWAP_CHAIN_DESC_N Ogre::D3D11RenderWindowSwapChainBased::mSwapChainDesc
protected

Definition at line 124 of file OgreD3D11RenderWindow.h.

Referenced by getPresentationParameters().

Timer* Ogre::RenderTarget::mTimer
protectedinherited

Definition at line 478 of file OgreRenderTarget.h.

int Ogre::RenderWindow::mTop
protectedinherited

Definition at line 201 of file OgreRenderWindow.h.

ViewportList Ogre::RenderTarget::mViewportList
protectedinherited

List of viewports, map on Z-order.

Definition at line 495 of file OgreRenderTarget.h.

bool Ogre::D3D11RenderWindowBase::mVSync
protectedinherited

Definition at line 92 of file OgreD3D11RenderWindow.h.

unsigned int Ogre::D3D11RenderWindowBase::mVSyncInterval
protectedinherited

Definition at line 93 of file OgreD3D11RenderWindow.h.

uint32 Ogre::RenderTarget::mWidth
protectedinherited

Definition at line 469 of file OgreRenderTarget.h.


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