HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HgiGLComputeCmds Class Referencefinal

#include <computeCmds.h>

+ Inheritance diagram for HgiGLComputeCmds:

Public Member Functions

HGIGL_API ~HgiGLComputeCmds () override
 
HGIGL_API void PushDebugGroup (const char *label) override
 Push a debug marker. More...
 
HGIGL_API void PopDebugGroup () override
 Pop the last debug marker. More...
 
HGIGL_API void BindPipeline (HgiComputePipelineHandle pipeline) override
 
HGIGL_API void BindResources (HgiResourceBindingsHandle resources) override
 
HGIGL_API void SetConstantValues (HgiComputePipelineHandle pipeline, uint32_t bindIndex, uint32_t byteSize, const void *data) override
 
HGIGL_API void Dispatch (int dimX, int dimY) override
 
HGIGL_API void InsertMemoryBarrier (HgiMemoryBarrier barrier) override
 
HGIGL_API HgiComputeDispatch GetDispatchMethod () const override
 Returns the dispatch method for this encoder. More...
 
- Public Member Functions inherited from HgiComputeCmds
HGI_API ~HgiComputeCmds () override
 
- Public Member Functions inherited from HgiCmds
virtual HGI_API ~HgiCmds ()
 
HGI_API bool IsSubmitted () const
 Returns true if the HgiCmds object has been submitted to GPU. More...
 

Protected Member Functions

HGIGL_API HgiGLComputeCmds (HgiGLDevice *device, HgiComputeCmdsDesc const &desc)
 
HGIGL_API bool _Submit (Hgi *hgi, HgiSubmitWaitType wait) override
 
- Protected Member Functions inherited from HgiComputeCmds
HGI_API HgiComputeCmds ()
 
- Protected Member Functions inherited from HgiCmds
HGI_API HgiCmds ()
 
HGI_API void _SetSubmitted ()
 

Friends

class HgiGL
 

Detailed Description

OpenGL implementation of HgiComputeCmds.

Definition at line 42 of file computeCmds.h.

Constructor & Destructor Documentation

HGIGL_API HgiGLComputeCmds::~HgiGLComputeCmds ( )
override
HGIGL_API HgiGLComputeCmds::HgiGLComputeCmds ( HgiGLDevice device,
HgiComputeCmdsDesc const &  desc 
)
protected

Member Function Documentation

HGIGL_API bool HgiGLComputeCmds::_Submit ( Hgi hgi,
HgiSubmitWaitType  wait 
)
overrideprotectedvirtual

Reimplemented from HgiCmds.

HGIGL_API void HgiGLComputeCmds::BindPipeline ( HgiComputePipelineHandle  pipeline)
overridevirtual

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().

Implements HgiComputeCmds.

HGIGL_API void HgiGLComputeCmds::BindResources ( HgiResourceBindingsHandle  resources)
overridevirtual

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.

Implements HgiComputeCmds.

HGIGL_API void HgiGLComputeCmds::Dispatch ( int  dimX,
int  dimY 
)
overridevirtual

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

Implements HgiComputeCmds.

HGIGL_API HgiComputeDispatch HgiGLComputeCmds::GetDispatchMethod ( ) const
overridevirtual

Returns the dispatch method for this encoder.

Implements HgiComputeCmds.

HGIGL_API void HgiGLComputeCmds::InsertMemoryBarrier ( HgiMemoryBarrier  barrier)
overridevirtual

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

Implements HgiComputeCmds.

HGIGL_API void HgiGLComputeCmds::PopDebugGroup ( )
overridevirtual

Pop the last debug marker.

Implements HgiComputeCmds.

HGIGL_API void HgiGLComputeCmds::PushDebugGroup ( const char *  label)
overridevirtual

Push a debug marker.

Implements HgiComputeCmds.

HGIGL_API void HgiGLComputeCmds::SetConstantValues ( HgiComputePipelineHandle  pipeline,
uint32_t  bindIndex,
uint32_t  byteSize,
const void data 
)
overridevirtual

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.

Implements HgiComputeCmds.

Friends And Related Function Documentation

friend class HgiGL
friend

Definition at line 77 of file computeCmds.h.


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