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

#include <OgreD3D11DepthBuffer.h>

+ Inheritance diagram for Ogre::D3D11DepthBuffer:
+ Collaboration diagram for Ogre::D3D11DepthBuffer:

Public Types

enum  PoolId { POOL_NO_DEPTH = 0, POOL_MANUAL_USAGE = 0, POOL_DEFAULT = 1 }
 

Public Member Functions

 D3D11DepthBuffer (uint16 poolId, D3D11RenderSystem *renderSystem, ID3D11DepthStencilView *depthBufferView, uint32 width, uint32 height, uint32 fsaa, uint32 multiSampleQuality, bool isManual)
 
 ~D3D11DepthBuffer ()
 
virtual void _notifyRenderTargetAttached (RenderTarget *renderTarget)
 Called when a RenderTarget is attaches this DepthBuffer. More...
 
virtual void _notifyRenderTargetDetached (RenderTarget *renderTarget)
 Called when a RenderTarget is detaches from this DepthBuffer. More...
 
void _resized (ID3D11DepthStencilView *depthBufferView, uint32 width, uint32 height)
 internal method, gets called when the renderwindow was resized More...
 
void _setPoolId (uint16 poolId)
 Sets the pool id in which this DepthBuffer lives. More...
 
virtual uint16 getBitDepth () const
 
ID3D11DepthStencilView * getDepthStencilView () const
 
virtual uint32 getFsaa () const
 
virtual const StringgetFsaaHint () const
 
virtual uint32 getHeight () const
 
virtual uint16 getPoolId () const
 Gets the pool id in which this DepthBuffer lives. More...
 
virtual uint32 getWidth () const
 
virtual bool isCompatible (RenderTarget *renderTarget) const
 Returns whether the specified RenderTarget is compatible with this DepthBuffer That is, this DepthBuffer can be attached to that RenderTarget. More...
 
bool isManual () const
 Manual DepthBuffers are cleared in RenderSystem's destructor. 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)
 

Protected Types

typedef set< RenderTarget * >::type RenderTargetSet
 

Protected Member Functions

void detachFromAllRenderTargets ()
 

Protected Attributes

RenderTargetSet mAttachedRenderTargets
 
uint16 mBitDepth
 
ID3D11DepthStencilView * mDepthStencilView
 
uint32 mFsaa
 
String mFsaaHint
 
uint32 mHeight
 
bool mManual
 
uint32 mMultiSampleQuality
 
uint16 mPoolId
 
D3D11RenderSystemmRenderSystem
 
uint32 mWidth
 

Detailed Description

Definition at line 36 of file OgreD3D11DepthBuffer.h.

Member Typedef Documentation

typedef set<RenderTarget*>::type Ogre::DepthBuffer::RenderTargetSet
protectedinherited

Definition at line 140 of file OgreDepthBuffer.h.

Member Enumeration Documentation

enum Ogre::DepthBuffer::PoolId
inherited
Enumerator
POOL_NO_DEPTH 
POOL_MANUAL_USAGE 
POOL_DEFAULT 

Definition at line 85 of file OgreDepthBuffer.h.

Constructor & Destructor Documentation

Ogre::D3D11DepthBuffer::D3D11DepthBuffer ( uint16  poolId,
D3D11RenderSystem renderSystem,
ID3D11DepthStencilView *  depthBufferView,
uint32  width,
uint32  height,
uint32  fsaa,
uint32  multiSampleQuality,
bool  isManual 
)
Ogre::D3D11DepthBuffer::~D3D11DepthBuffer ( )

Member Function Documentation

virtual void Ogre::DepthBuffer::_notifyRenderTargetAttached ( RenderTarget renderTarget)
virtualinherited

Called when a RenderTarget is attaches this DepthBuffer.

Remarks
This function doesn't actually attach. It merely informs the DepthBuffer which RenderTarget did attach. The real attachment happens in RenderTarget::attachDepthBuffer()
Parameters
renderTargetThe RenderTarget that has just been attached
virtual void Ogre::DepthBuffer::_notifyRenderTargetDetached ( RenderTarget renderTarget)
virtualinherited

Called when a RenderTarget is detaches from this DepthBuffer.

Remarks
Same as DepthBuffer::_notifyRenderTargetAttached()
Parameters
renderTargetThe RenderTarget that has just been detached
void Ogre::D3D11DepthBuffer::_resized ( ID3D11DepthStencilView *  depthBufferView,
uint32  width,
uint32  height 
)

internal method, gets called when the renderwindow was resized

void Ogre::DepthBuffer::_setPoolId ( uint16  poolId)
inherited

Sets the pool id in which this DepthBuffer lives.

Note this will detach any render target from this depth buffer

void Ogre::DepthBuffer::detachFromAllRenderTargets ( )
protectedinherited
virtual uint16 Ogre::DepthBuffer::getBitDepth ( ) const
virtualinherited
ID3D11DepthStencilView* Ogre::D3D11DepthBuffer::getDepthStencilView ( ) const
virtual uint32 Ogre::DepthBuffer::getFsaa ( ) const
virtualinherited
virtual const String& Ogre::DepthBuffer::getFsaaHint ( ) const
virtualinherited
virtual uint32 Ogre::DepthBuffer::getHeight ( ) const
virtualinherited
virtual uint16 Ogre::DepthBuffer::getPoolId ( ) const
virtualinherited

Gets the pool id in which this DepthBuffer lives.

virtual uint32 Ogre::DepthBuffer::getWidth ( ) const
virtualinherited
virtual bool Ogre::D3D11DepthBuffer::isCompatible ( RenderTarget renderTarget) const
virtual

Returns whether the specified RenderTarget is compatible with this DepthBuffer That is, this DepthBuffer can be attached to that RenderTarget.

Remarks
Most APIs impose the following restrictions: Width & height must be equal or higher than the render target's They must be of the same bit depth. They need to have the same FSAA setting
Parameters
renderTargetThe render target to test against

Reimplemented from Ogre::DepthBuffer.

bool Ogre::DepthBuffer::isManual ( ) const
inherited

Manual DepthBuffers are cleared in RenderSystem's destructor.

Non-manual ones are released with it's render target (aka, a backbuffer or similar)

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.

Member Data Documentation

RenderTargetSet Ogre::DepthBuffer::mAttachedRenderTargets
protectedinherited

Definition at line 150 of file OgreDepthBuffer.h.

uint16 Ogre::DepthBuffer::mBitDepth
protectedinherited

Definition at line 143 of file OgreDepthBuffer.h.

ID3D11DepthStencilView* Ogre::D3D11DepthBuffer::mDepthStencilView
protected

Definition at line 53 of file OgreD3D11DepthBuffer.h.

uint32 Ogre::DepthBuffer::mFsaa
protectedinherited

Definition at line 146 of file OgreDepthBuffer.h.

String Ogre::DepthBuffer::mFsaaHint
protectedinherited

Definition at line 147 of file OgreDepthBuffer.h.

uint32 Ogre::DepthBuffer::mHeight
protectedinherited

Definition at line 145 of file OgreDepthBuffer.h.

bool Ogre::DepthBuffer::mManual
protectedinherited

Definition at line 149 of file OgreDepthBuffer.h.

uint32 Ogre::D3D11DepthBuffer::mMultiSampleQuality
protected

Definition at line 54 of file OgreD3D11DepthBuffer.h.

uint16 Ogre::DepthBuffer::mPoolId
protectedinherited

Definition at line 142 of file OgreDepthBuffer.h.

D3D11RenderSystem* Ogre::D3D11DepthBuffer::mRenderSystem
protected

Definition at line 55 of file OgreD3D11DepthBuffer.h.

uint32 Ogre::DepthBuffer::mWidth
protectedinherited

Definition at line 144 of file OgreDepthBuffer.h.


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