HgiComputeCmds Class Reference

A graphics API independent abstraction of compute commands. More...

#include <computeCmds.h>

Inheritance diagram for HgiComputeCmds:

Public Member Functions
virtual HGI_API void	PushDebugGroup (const char *label, const GfVec4f &color=s_computeDebugColor)=0
	Push a debug scope.
virtual HGI_API void	PopDebugGroup ()=0
	Pop the last debug scope.
virtual HGI_API void	InsertDebugMarker (const char *label, const GfVec4f &color=s_markerDebugColor)=0
	Insert a debug marker.
virtual HGI_API void	BindPipeline (HgiComputePipelineHandle pipeline)=0
	Bind a pipeline state object.
virtual HGI_API void	BindResources (HgiResourceBindingsHandle resources)=0
	Bind resources such as textures and uniform buffers.
virtual HGI_API void	SetConstantValues (HgiComputePipelineHandle pipeline, uint32_t bindIndex, uint32_t byteSize, const void *data)=0
	Set Push / Function constants.
virtual HGI_API void	Dispatch (int dimX, int dimY)=0
	Execute a compute shader with provided thread group count in each dimension.
virtual HGI_API void	InsertMemoryBarrier (HgiMemoryBarrier barrier)=0
	Inserts a barrier so that data written to memory by commands before the barrier is available to commands after the barrier.
virtual HGI_API HgiComputeDispatch	GetDispatchMethod () const =0
	Returns the dispatch method for this encoder.
Public Member Functions inherited from HgiCmds
HGI_API bool	IsSubmitted () const
	Returns true if the HgiCmds object has been submitted to GPU.

Additional Inherited Members
Protected Member Functions inherited from HgiCmds
virtual HGI_API bool	_Submit (Hgi *hgi, HgiSubmitWaitType wait)
HGI_API void	_SetSubmitted ()
Static Protected Attributes inherited from HgiCmds
static constexpr GfVec4f	s_computeDebugColor = { 0.855, 0.161, 0.11, 1.0 }
static constexpr GfVec4f	s_graphicsDebugColor = { 0, 0.639, 0.878, 1.0 }
static constexpr GfVec4f	s_blitDebugColor = { 0.99607843137, 0.87450980392, 0.0, 1.0 }
static constexpr GfVec4f	s_markerDebugColor = { 0.0, 0.0, 0.0, 0.0 }

Detailed Description

A graphics API independent abstraction of compute commands.

HgiComputeCmds is a lightweight object that cannot be re-used after it has been submitted. A new cmds object should be acquired for each frame.

Definition at line 28 of file computeCmds.h.

Member Function Documentation

BindPipeline()

virtual HGI_API void BindPipeline ( HgiComputePipelineHandle  pipeline )

pure virtual

Bind a pipeline state object.

Usually you call this right after calling CreateGraphicsCmds to set the graphics pipeline state. The resource bindings used when creating the pipeline must be compatible with the resources bound via BindResources().

Implemented in HgiGLComputeCmds.

BindResources()

virtual HGI_API void BindResources ( HgiResourceBindingsHandle  resources )

pure virtual

Bind resources such as textures and uniform buffers.

Usually you call this right after BindPipeline() and the resources bound must be compatible with the bound pipeline.

Implemented in HgiGLComputeCmds.

Dispatch()

virtual HGI_API void Dispatch ( int  dimX, int  dimY  )

pure virtual

Execute a compute shader with provided thread group count in each dimension.

Implemented in HgiGLComputeCmds.

GetDispatchMethod()

virtual HGI_API HgiComputeDispatch GetDispatchMethod ( ) const

pure virtual

Returns the dispatch method for this encoder.

Implemented in HgiGLComputeCmds.

InsertDebugMarker()

virtual HGI_API void InsertDebugMarker ( const char *  label, const GfVec4f &  color = s_markerDebugColor  )

pure virtual

Insert a debug marker.

Implemented in HgiGLComputeCmds.

InsertMemoryBarrier()

virtual HGI_API void InsertMemoryBarrier ( HgiMemoryBarrier  barrier )

pure virtual

Inserts a barrier so that data written to memory by commands before the barrier is available to commands after the barrier.

Implemented in HgiGLComputeCmds.

PopDebugGroup()

virtual HGI_API void PopDebugGroup ( )

pure virtual

Pop the last debug scope.

Implemented in HgiGLComputeCmds.

PushDebugGroup()

virtual HGI_API void PushDebugGroup ( const char *  label, const GfVec4f &  color = s_computeDebugColor  )

pure virtual

Push a debug scope.

Implemented in HgiGLComputeCmds.

SetConstantValues()

virtual HGI_API void SetConstantValues ( HgiComputePipelineHandle  pipeline, uint32_t  bindIndex, uint32_t  byteSize, const void *  data  )

pure virtual

Set Push / Function constants.

pipeline is the compute pipeline that you are binding before the draw call. It contains the program used for the uniform buffer constant values for. bindIndex is the binding point index in the pipeline's shader to bind the data to. byteSize is the size of the data you are updating. data is the data you are copying into the push constants block.

Implemented in HgiGLComputeCmds.

---

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

• pxr/imaging/hgi/computeCmds.h