Ogre::CompositorPassClearDef Class Reference

#include <OgreCompositorPassClearDef.h>

Inheritance diagram for Ogre::CompositorPassClearDef:

Public Types
typedef vector< UavDependency >::type	UavDependencyVec

Public Member Functions
	CompositorPassClearDef (CompositorTargetDef *parentTargetDef)
	By default clear all buffers.
const CompositorTargetDef *	getParentTargetDef (void) const
uint32	getRtIndex (void) const
CompositorPassType	getType () const
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info

Public Attributes
bool	mBeginRtUpdate
	True if a previous pass doesn't alter the contents of the same render target we do TODO: Fill this automatically.
uint32	mClearBufferFlags
ColourValue	mColourValue
bool	mColourWrite
	When false will not really bind the RenderTarget for rendering and use a null colour buffer instead.
Real	mDepthValue
bool	mDiscardOnly
	This value is only supported by a few APIs (D3D11 at the time of writting) which instead of actually clearing the buffers, it informs the GPU that the entire contents will be overwritten, which is what happens with fullscreen quad pass.
bool	mEndRtUpdate
	End if we're the last consecutive pass to alter the contents of the same render target.
uint8	mExecutionMask
IdStringVec	mExposedTextures
uint32	mIdentifier
	Custom value in case there's a listener attached (to identify the pass)
bool	mIncludeOverlays
	TODO: Refactor OgreOverlay to remove this design atrocity.
uint32	mNumInitialPasses
	Number of times to perform the pass before stopping. -1 to never stop.
String	mProfilingId
bool	mReadOnlyDepth
bool	mReadOnlyStencil
bool	mShadowMapFullViewport
	Only used if mShadowMapIdx is valid (if pass is owned by Shadow Nodes).
uint32	mShadowMapIdx
	Shadow map index it belongs to (only filled in passes owned by Shadow Nodes)
uint32	mStencilValue
UavDependencyVec	mUavDependencies
uint8	mViewportModifierMask
float	mVpHeight
float	mVpLeft
	Viewport's region to draw.
float	mVpScissorHeight
float	mVpScissorLeft
float	mVpScissorTop
float	mVpScissorWidth
float	mVpTop
float	mVpWidth

Member Typedef Documentation

UavDependencyVec

typedef vector<UavDependency>::type Ogre::CompositorPassDef::UavDependencyVec

inherited

Constructor & Destructor Documentation

CompositorPassClearDef()

Ogre::CompositorPassClearDef::CompositorPassClearDef ( CompositorTargetDef *  parentTargetDef )

inline

By default clear all buffers.

Stencil needs to be cleared because it hinders Fast Z Clear on GPU architectures that don't separate the stencil from depth and the program requested a Z Buffer with stencil (even if we never use it)

Member Function Documentation

getParentTargetDef()

const CompositorTargetDef * Ogre::CompositorPassDef::getParentTargetDef ( void  ) const

inherited

getRtIndex()

uint32 Ogre::CompositorPassDef::getRtIndex ( void  ) const

inherited

getType()

CompositorPassType Ogre::CompositorPassDef::getType ( ) const

inlineinherited

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

Member Data Documentation

mBeginRtUpdate

bool Ogre::CompositorPassDef::mBeginRtUpdate

inherited

True if a previous pass doesn't alter the contents of the same render target we do TODO: Fill this automatically.

mClearBufferFlags

uint32 Ogre::CompositorPassClearDef::mClearBufferFlags

mColourValue

ColourValue Ogre::CompositorPassClearDef::mColourValue

mColourWrite

bool Ogre::CompositorPassDef::mColourWrite

inherited

When false will not really bind the RenderTarget for rendering and use a null colour buffer instead.

Useful for depth prepass, or if the RTT is actually an UAV. Some passes may ignore this setting (e.g. Clear passes)

mDepthValue

Real Ogre::CompositorPassClearDef::mDepthValue

mDiscardOnly

bool Ogre::CompositorPassClearDef::mDiscardOnly

This value is only supported by a few APIs (D3D11 at the time of writting) which instead of actually clearing the buffers, it informs the GPU that the entire contents will be overwritten, which is what happens with fullscreen quad pass.

Remarks

When the API does not support discard-only clears, the pass is ignored

The main purpose of this feature is to be friendly with multi-GPU systems (since we're telling there is no dependency with a previous frame) while avoid doing a full clear at the same time (wastes bandwidth)

When performing PASS_QUAD that covers the entire render target and doesn't have alpha blending, a discard is automatically performed on the colour buffer.

Warning: Incorrect usage of discard only clears can lead to visual artifacts

mEndRtUpdate

bool Ogre::CompositorPassDef::mEndRtUpdate

inherited

End if we're the last consecutive pass to alter the contents of the same render target.

mExecutionMask

uint8 Ogre::CompositorPassDef::mExecutionMask

inherited

mExposedTextures

IdStringVec Ogre::CompositorPassDef::mExposedTextures

inherited

mIdentifier

uint32 Ogre::CompositorPassDef::mIdentifier

inherited

Custom value in case there's a listener attached (to identify the pass)

mIncludeOverlays

bool Ogre::CompositorPassDef::mIncludeOverlays

inherited

TODO: Refactor OgreOverlay to remove this design atrocity.

A custom overlay pass is a better alternative (or just use their own RQ)

mNumInitialPasses

uint32 Ogre::CompositorPassDef::mNumInitialPasses

inherited

Number of times to perform the pass before stopping. -1 to never stop.

mProfilingId

String Ogre::CompositorPassDef::mProfilingId

inherited

mReadOnlyDepth

bool Ogre::CompositorPassDef::mReadOnlyDepth

inherited

mReadOnlyStencil

bool Ogre::CompositorPassDef::mReadOnlyStencil

inherited

mShadowMapFullViewport

bool Ogre::CompositorPassDef::mShadowMapFullViewport

inherited

Only used if mShadowMapIdx is valid (if pass is owned by Shadow Nodes).

If true, we won't force the viewport to fit the region of the UV atlas on the texture, and respect mVp* settings instead.

mShadowMapIdx

uint32 Ogre::CompositorPassDef::mShadowMapIdx

inherited

Shadow map index it belongs to (only filled in passes owned by Shadow Nodes)

mStencilValue

uint32 Ogre::CompositorPassClearDef::mStencilValue

mUavDependencies

UavDependencyVec Ogre::CompositorPassDef::mUavDependencies

inherited

mViewportModifierMask

uint8 Ogre::CompositorPassDef::mViewportModifierMask

inherited

mVpHeight

float Ogre::CompositorPassDef::mVpHeight

inherited

mVpLeft

float Ogre::CompositorPassDef::mVpLeft

inherited

Viewport's region to draw.

mVpScissorHeight

float Ogre::CompositorPassDef::mVpScissorHeight

inherited

mVpScissorLeft

float Ogre::CompositorPassDef::mVpScissorLeft

inherited

mVpScissorTop

float Ogre::CompositorPassDef::mVpScissorTop

inherited

mVpScissorWidth

float Ogre::CompositorPassDef::mVpScissorWidth

inherited

mVpTop

float Ogre::CompositorPassDef::mVpTop

inherited

mVpWidth

float Ogre::CompositorPassDef::mVpWidth

inherited

---

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

• OgreCompositorPassClearDef.h