A graphics API independent abstraction of compute commands. More...
Public Member Functions | |
virtual HGI_API void | PushDebugGroup (const char *label)=0 |
Push a debug marker. More... | |
virtual HGI_API void | PopDebugGroup ()=0 |
Pop the last debug marker. More... | |
virtual HGI_API void | BindPipeline (HgiComputePipelineHandle pipeline)=0 |
Bind a pipeline state object. More... | |
virtual HGI_API void | BindResources (HgiResourceBindingsHandle resources)=0 |
Bind resources such as textures and uniform buffers. More... | |
virtual HGI_API void | SetConstantValues (HgiComputePipelineHandle pipeline, uint32_t bindIndex, uint32_t byteSize, const void *data)=0 |
Set Push / Function constants. More... | |
virtual HGI_API void | Dispatch (int dimX, int dimY)=0 |
Execute a compute shader with provided thread group count in each dimension. More... | |
virtual HGI_API void | MemoryBarrier (HgiMemoryBarrier barrier)=0 |
Inserts a barrier so that data written to memory by commands before the barrier is available to commands after the barrier. More... | |
Public Member Functions inherited from HgiCmds | |
HGI_API bool | IsSubmitted () const |
Returns true if the HgiCmds object has been submitted to GPU. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from HgiCmds | |
virtual HGI_API bool | _Submit (Hgi *hgi, HgiSubmitWaitType wait) |
HGI_API void | _SetSubmitted () |
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 45 of file computeCmds.h.
|
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.
|
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.
|
pure virtual |
Execute a compute shader with provided thread group count in each dimension.
Implemented in HgiGLComputeCmds.
|
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.
|
pure virtual |
Pop the last debug marker.
Implemented in HgiGLComputeCmds.
|
pure virtual |
Push a debug marker.
Implemented in HgiGLComputeCmds.
|
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.