Ogre::CompositorPassComputeDef Class Reference

#include <OgreCompositorPassComputeDef.h>

Inheritance diagram for Ogre::CompositorPassComputeDef:

Classes
struct	BufferSource
struct	ComputeTextureSource

Public Types
typedef vector< BufferSource >::type	BufferSourceVec
typedef vector< ComputeTextureSource >::type	TextureSources
typedef vector< UavDependency >::type	UavDependencyVec

Public Member Functions
	CompositorPassComputeDef (CompositorNodeDef *parentNodeDef, CompositorTargetDef *parentTargetDef)
void	addTextureSource (uint32 texUnitIdx, const String &textureName, uint32 mrtIndex)
	Indicates the pass to change the texture units to use the specified texture sources.
void	addUavBuffer (uint32 slotIdx, const String &bufferName, ResourceAccess::ResourceAccess access, size_t offset=0, size_t sizeBytes=0, bool allowWriteAfterWrite=false)
void	addUavSource (uint32 texUnitIdx, const String &textureName, uint32 mrtIndex, ResourceAccess::ResourceAccess access, int32 textureArrayIndex, int32 mipmapLevel, PixelFormat pixelFormat, bool allowWriteAfterWrite)
const BufferSourceVec &	getBufferSources (void) const
const CompositorTargetDef *	getParentTargetDef (void) const
uint32	getRtIndex (void) const
const TextureSources &	getTextureSources (void) const
CompositorPassType	getType () const
const TextureSources &	getUavSources (void) 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.
IdString	mCameraName
bool	mColourWrite
	When false will not really bind the RenderTarget for rendering and use a null colour buffer instead.
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.
IdString	mJobName
	Name of the HlmsComputeJob to run.
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)
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

BufferSourceVec

typedef vector<BufferSource>::type Ogre::CompositorPassComputeDef::BufferSourceVec

TextureSources

typedef vector<ComputeTextureSource>::type Ogre::CompositorPassComputeDef::TextureSources

UavDependencyVec

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

inherited

Constructor & Destructor Documentation

CompositorPassComputeDef()

Ogre::CompositorPassComputeDef::CompositorPassComputeDef ( CompositorNodeDef *  parentNodeDef, CompositorTargetDef *  parentTargetDef  )

inline

Member Function Documentation

addTextureSource()

void Ogre::CompositorPassComputeDef::addTextureSource	(	uint32	texUnitIdx,
		const String &	textureName,
		uint32	mrtIndex
	)

Indicates the pass to change the texture units to use the specified texture sources.

@See ComputeTextureSource for params

addUavBuffer()

void Ogre::CompositorPassComputeDef::addUavBuffer	(	uint32	slotIdx,
		const String &	bufferName,
		ResourceAccess::ResourceAccess	access,
		size_t	offset = 0,
		size_t	sizeBytes = 0,
		bool	allowWriteAfterWrite = false
	)

addUavSource()

void Ogre::CompositorPassComputeDef::addUavSource	(	uint32	texUnitIdx,
		const String &	textureName,
		uint32	mrtIndex,
		ResourceAccess::ResourceAccess	access,
		int32	textureArrayIndex,
		int32	mipmapLevel,
		PixelFormat	pixelFormat,
		bool	allowWriteAfterWrite
	)

getBufferSources()

const BufferSourceVec & Ogre::CompositorPassComputeDef::getBufferSources ( void  ) const

inline

getParentTargetDef()

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

inherited

getRtIndex()

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

inherited

getTextureSources()

const TextureSources & Ogre::CompositorPassComputeDef::getTextureSources ( void  ) const

inline

getType()

CompositorPassType Ogre::CompositorPassDef::getType ( ) const

inlineinherited

getUavSources()

const TextureSources & Ogre::CompositorPassComputeDef::getUavSources ( void  ) const

inline

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.

mCameraName

IdString Ogre::CompositorPassComputeDef::mCameraName

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)

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)

mJobName

IdString Ogre::CompositorPassComputeDef::mJobName

Name of the HlmsComputeJob to run.

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)

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:

• OgreCompositorPassComputeDef.h