ComputeQueue Class Reference

#include <ComputeQueue.h>

Inheritance diagram for ComputeQueue:

Public Types
enum class	EBarrier { Yes , No }
	If a barrier should be placed before accessing the buffer. More...

Public Member Functions
virtual JPH_OVERRIDE_NEW_DELETE	~ComputeQueue ()=default
	Destructor.
virtual void	SetShader (const ComputeShader *inShader)=0
virtual void	SetConstantBuffer (const char *inName, const ComputeBuffer *inBuffer)=0
virtual void	SetBuffer (const char *inName, const ComputeBuffer *inBuffer)=0
virtual void	SetRWBuffer (const char *inName, ComputeBuffer *inBuffer, EBarrier inBarrier=EBarrier::Yes)=0
virtual void	Dispatch (uint inThreadGroupsX, uint inThreadGroupsY=1, uint inThreadGroupsZ=1)=0
	Dispatch a compute shader with the specified number of thread groups.
virtual void	ScheduleReadback (ComputeBuffer *inDst, const ComputeBuffer *inSrc)=0
virtual void	Execute ()=0
virtual void	Wait ()=0
void	ExecuteAndWait ()
Public Member Functions inherited from RefTarget< ComputeQueue >
	RefTarget ()=default
	Constructor.
	RefTarget (const RefTarget &)
	~RefTarget ()
	assert no one is referencing us
void	SetEmbedded () const
RefTarget &	operator= (const RefTarget &)
	Assignment operator.
uint32	GetRefCount () const
	Get current refcount of this object.
void	AddRef () const
	Add or release a reference to this object.
void	Release () const
Public Member Functions inherited from NonCopyable
	NonCopyable ()=default
	NonCopyable (const NonCopyable &)=delete
void	operator= (const NonCopyable &)=delete

Additional Inherited Members
Static Public Member Functions inherited from RefTarget< ComputeQueue >
static int	sInternalGetRefCountOffset ()
	INTERNAL HELPER FUNCTION USED BY SERIALIZATION.
Protected Attributes inherited from RefTarget< ComputeQueue >
atomic< uint32 >	mRefCount
	Current reference count.
Static Protected Attributes inherited from RefTarget< ComputeQueue >
static constexpr uint32	cEmbedded
	A large value that gets added to the refcount to mark the object as embedded.

Detailed Description

A command queue for executing compute workloads on the GPU.

Note that only a single thread should be using a ComputeQueue at any time (although an implementation could be made that is thread safe).

Member Enumeration Documentation

EBarrier

enum class ComputeQueue::EBarrier

strong

If a barrier should be placed before accessing the buffer.

Enumerator
Yes
No

Constructor & Destructor Documentation

~ComputeQueue()

virtual JPH_OVERRIDE_NEW_DELETE ComputeQueue::~ComputeQueue ( )

virtualdefault

Destructor.

Member Function Documentation

Dispatch()

virtual void ComputeQueue::Dispatch ( uint inThreadGroupsX, uint inThreadGroupsY = 1, uint inThreadGroupsZ = 1 )

pure virtual

Dispatch a compute shader with the specified number of thread groups.

Execute()

virtual void ComputeQueue::Execute ( )

pure virtual

Execute accumulated command list. No more commands can be added until Wait is called.

ExecuteAndWait()

void ComputeQueue::ExecuteAndWait ( )

inline

Execute and wait for the command list to finish

See also

Execute, Wait

ScheduleReadback()

virtual void ComputeQueue::ScheduleReadback ( ComputeBuffer * inDst, const ComputeBuffer * inSrc )

pure virtual

Schedule buffer to be copied from GPU to CPU. A reference to the buffers is added to make sure they stay alive until execution finishes.

SetBuffer()

virtual void ComputeQueue::SetBuffer ( const char * inName, const ComputeBuffer * inBuffer )

pure virtual

Bind a read only buffer to the shader. Note that the contents of the buffer cannot be modified on CPU until execution finishes (only relevant for buffers of type UploadBuffer). A reference to the buffer is added to make sure it stays alive until execution finishes.

Parameters

inName	Name of the buffer as specified in the shader.
inBuffer	The buffer to bind.

SetConstantBuffer()

virtual void ComputeQueue::SetConstantBuffer ( const char * inName, const ComputeBuffer * inBuffer )

pure virtual

Bind a constant buffer to the shader. Note that the contents of the buffer cannot be modified until execution finishes. A reference to the buffer is added to make sure it stays alive until execution finishes.

Parameters

inName	Name of the buffer as specified in the shader.
inBuffer	The buffer to bind.

SetRWBuffer()

virtual void ComputeQueue::SetRWBuffer ( const char * inName, ComputeBuffer * inBuffer, EBarrier inBarrier = EBarrier::Yes )

pure virtual

Bind a read/write buffer to the shader. A reference to the buffer is added to make sure it stays alive until execution finishes.

Parameters

inName	Name of the buffer as specified in the shader.
inBuffer	The buffer to bind.
inBarrier	If set to Yes, a barrier will be placed before accessing the buffer to ensure all previous writes to the buffer are visible.

SetShader()

virtual void ComputeQueue::SetShader ( const ComputeShader * inShader )

pure virtual

Activate a shader. Shader must be set first before buffers can be bound. After every Dispatch call, the shader must be set again and all buffers must be bound again.

Wait()

virtual void ComputeQueue::Wait ( )

pure virtual

After executing, this waits until execution is done. This also makes sure that any readback operations have completed and the data is available on CPU.

---

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

• Jolt/Compute/ComputeQueue.h