#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)
	Indicates the pass to change the texture units to use the specified texture sources. More...

void	addTextureSource (uint32 texUnitIdx, const String &textureName, int32 textureArrayIndex, int32 mipmapLevel, PixelFormatGpu pixelFormat)

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, ResourceAccess::ResourceAccess access, int32 textureArrayIndex, int32 mipmapLevel, PixelFormatGpu pixelFormat, bool allowWriteAfterWrite)

const BufferSourceVec &	getBufferSources () const

const CompositorTargetDef *	getParentTargetDef () const

uint32	getRtIndex () const

const TextureSources &	getTextureSources () const

CompositorPassType	getType () const

const TextureSources &	getUavSources () 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 More...

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

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 More...

void	setAllClearColours (const ColourValue &clearValue)

void	setAllLoadActions (LoadAction::LoadAction loadAction)

void	setAllStoreActions (StoreAction::StoreAction storeAction)

Public Attributes
IdString	mCameraName

ColourValue	mClearColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]

float	mClearDepth

uint32	mClearStencil

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

uint8	mExecutionMask

IdStringVec	mExposedTextures

bool	mFlushCommandBuffers
	Whether to flush the command buffer at the end of the pass. More...

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

bool	mIncludeOverlays
	TODO: Refactor OgreOverlay to remove this design atrocity. More...

IdString	mJobName
	Name of the HlmsComputeJob to run. More...

LoadAction::LoadAction	mLoadActionColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]

LoadAction::LoadAction	mLoadActionDepth

LoadAction::LoadAction	mLoadActionStencil

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

uint32	mNumViewports

String	mProfilingId

bool	mReadOnlyDepth

bool	mReadOnlyStencil

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

uint32	mShadowMapIdx
	Shadow map index it belongs to (only filled in passes owned by Shadow Nodes) More...

bool	mSkipLoadStoreSemantics
	Ignore mLoadAction‍/mStoreAction. More...

StoreAction::StoreAction	mStoreActionColour [OGRE_MAX_MULTIPLE_RENDER_TARGETS]

StoreAction::StoreAction	mStoreActionDepth

StoreAction::StoreAction	mStoreActionStencil

UavDependencyVec	mUavDependencies

uint8	mViewportModifierMask

ViewportRect	mVpRect [16]
	Viewport's region to draw. More...

bool	mWarnIfRtvWasFlushed
	Will issue a warning (by raising an exception) if Ogre is forced to flush the RenderTarget, which is very bad for performance on mobile, and can cause serious performance problems in Desktop if using MSAA, and also cause correctness problems (i.e. More...

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() [1/2]

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

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

@See ComputeTextureSource for params

◆ addTextureSource() [2/2]

void Ogre::CompositorPassComputeDef::addTextureSource	(	uint32	texUnitIdx,
		const String &	textureName,
		int32	textureArrayIndex,
		int32	mipmapLevel,
		PixelFormatGpu	pixelFormat
	)

◆ 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,
		ResourceAccess::ResourceAccess	access,
		int32	textureArrayIndex,
		int32	mipmapLevel,
		PixelFormatGpu	pixelFormat,
		bool	allowWriteAfterWrite
	)

◆ getBufferSources()

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

inline

◆ getParentTargetDef()

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

inherited

◆ getRtIndex()

uint32 Ogre::CompositorPassDef::getRtIndex ( ) const

inherited

◆ getTextureSources()

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

inline

◆ getType()

CompositorPassType Ogre::CompositorPassDef::getType ( ) const

inlineinherited

◆ getUavSources()

const TextureSources& Ogre::CompositorPassComputeDef::getUavSources ( ) 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

◆ setAllClearColours()

void Ogre::CompositorPassDef::setAllClearColours ( const ColourValue & clearValue )

inherited

◆ setAllLoadActions()

void Ogre::CompositorPassDef::setAllLoadActions ( LoadAction::LoadAction loadAction )

inherited

◆ setAllStoreActions()

void Ogre::CompositorPassDef::setAllStoreActions ( StoreAction::StoreAction storeAction )

inherited

Member Data Documentation

◆ mCameraName

IdString Ogre::CompositorPassComputeDef::mCameraName

◆ mClearColour

ColourValue Ogre::CompositorPassDef::mClearColour[OGRE_MAX_MULTIPLE_RENDER_TARGETS]

inherited

◆ mClearDepth

float Ogre::CompositorPassDef::mClearDepth

inherited

◆ mClearStencil

uint32 Ogre::CompositorPassDef::mClearStencil

inherited

◆ 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)

◆ mExecutionMask

uint8 Ogre::CompositorPassDef::mExecutionMask

inherited

◆ mExposedTextures

IdStringVec Ogre::CompositorPassDef::mExposedTextures

inherited

◆ mFlushCommandBuffers

bool Ogre::CompositorPassDef::mFlushCommandBuffers

inherited

Whether to flush the command buffer at the end of the pass.

This can incur in a performance overhead (see OpenGL's glFlush and D3D11' ID3D11DeviceContext::Flush) for info. Usually you want to leave this off. However for VR applications that must meet VSync, profiling may show your workload benefits from submitting earlier so the GPU can start right away executing rendering commands.

The main reason to use this is in CPU-bound scenarios where the GPU starts too late after sitting idle.

◆ 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.

◆ mLoadActionColour

LoadAction::LoadAction Ogre::CompositorPassDef::mLoadActionColour[OGRE_MAX_MULTIPLE_RENDER_TARGETS]

inherited

◆ mLoadActionDepth

LoadAction::LoadAction Ogre::CompositorPassDef::mLoadActionDepth

inherited

◆ mLoadActionStencil

LoadAction::LoadAction Ogre::CompositorPassDef::mLoadActionStencil

inherited

◆ mNumInitialPasses

uint32 Ogre::CompositorPassDef::mNumInitialPasses

inherited

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

◆ mNumViewports

uint32 Ogre::CompositorPassDef::mNumViewports

inherited

◆ 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)

◆ mSkipLoadStoreSemantics

bool Ogre::CompositorPassDef::mSkipLoadStoreSemantics

inherited

Ignore mLoadAction*‍/mStoreAction*.

Useful when doing multiple passes and you want to continue using the same pass semantics opened by a previous pass

Be careful with this setting. It can silently break a lot of stuff

Only valid for PASS_QUAD and PASS_SCENE

◆ mStoreActionColour

StoreAction::StoreAction Ogre::CompositorPassDef::mStoreActionColour[OGRE_MAX_MULTIPLE_RENDER_TARGETS]

inherited

◆ mStoreActionDepth

StoreAction::StoreAction Ogre::CompositorPassDef::mStoreActionDepth

inherited

◆ mStoreActionStencil

StoreAction::StoreAction Ogre::CompositorPassDef::mStoreActionStencil

inherited

◆ mUavDependencies

UavDependencyVec Ogre::CompositorPassDef::mUavDependencies

inherited

◆ mViewportModifierMask

uint8 Ogre::CompositorPassDef::mViewportModifierMask

inherited

◆ mVpRect

ViewportRect Ogre::CompositorPassDef::mVpRect[16]

inherited

Viewport's region to draw.

◆ mWarnIfRtvWasFlushed

bool Ogre::CompositorPassDef::mWarnIfRtvWasFlushed

inherited

Will issue a warning (by raising an exception) if Ogre is forced to flush the RenderTarget, which is very bad for performance on mobile, and can cause serious performance problems in Desktop if using MSAA, and also cause correctness problems (i.e.

bad rendering) if store action is StoreAction::Resolve.

Remarks: Flushes are caused by splitting rendering to the same RenderTarget in multiple passes while rendering to a different RenderTarget in the middle. It's not always possible to avoid it, but if so, consider doing it.

: No warning will be issued if the RenderTargets getting flushed have their LoadAction set to LoadAction::Clear (or LoadAction::ClearOnTilers on tilers).

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

OgreCompositorPassComputeDef.h

Classes

Public Types

Public Member Functions

Public Attributes

Member Typedef Documentation

◆ BufferSourceVec

◆ TextureSources

◆ UavDependencyVec

Constructor & Destructor Documentation

◆ CompositorPassComputeDef()

Member Function Documentation

◆ addTextureSource() [1/2]

◆ addTextureSource() [2/2]

◆ addUavBuffer()

◆ addUavSource()

◆ getBufferSources()

◆ getParentTargetDef()

◆ getRtIndex()

◆ getTextureSources()

◆ getType()

◆ getUavSources()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ setAllClearColours()

◆ setAllLoadActions()

◆ setAllStoreActions()

Member Data Documentation

◆ mCameraName

◆ mClearColour

◆ mClearDepth

◆ mClearStencil

◆ mColourWrite

◆ mExecutionMask

◆ mExposedTextures

◆ mFlushCommandBuffers

◆ mIdentifier

◆ mIncludeOverlays

◆ mJobName

◆ mLoadActionColour

◆ mLoadActionDepth

◆ mLoadActionStencil

◆ mNumInitialPasses

◆ mNumViewports

◆ mProfilingId

◆ mReadOnlyDepth

◆ mReadOnlyStencil

◆ mShadowMapFullViewport

◆ mShadowMapIdx

◆ mSkipLoadStoreSemantics

◆ mStoreActionColour

◆ mStoreActionDepth

◆ mStoreActionStencil

◆ mUavDependencies

◆ mViewportModifierMask

◆ mVpRect

◆ mWarnIfRtvWasFlushed