Loading...
Searching...
No Matches
computeCmds.h
1//
2// Copyright 2020 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_IMAGING_HGI_COMPUTE_CMDS_H
8#define PXR_IMAGING_HGI_COMPUTE_CMDS_H
9
10#include "pxr/pxr.h"
11#include "pxr/imaging/hgi/api.h"
12#include "pxr/imaging/hgi/computePipeline.h"
13#include "pxr/imaging/hgi/resourceBindings.h"
14#include "pxr/imaging/hgi/cmds.h"
15#include <memory>
16
17PXR_NAMESPACE_OPEN_SCOPE
18
19using HgiComputeCmdsUniquePtr = std::unique_ptr<class HgiComputeCmds>;
20
21
28class HgiComputeCmds : public HgiCmds
29{
30public:
31 HGI_API
32 ~HgiComputeCmds() override;
33
35 HGI_API
36 virtual void PushDebugGroup(const char* label) = 0;
37
39 HGI_API
40 virtual void PopDebugGroup() = 0;
41
46 HGI_API
47 virtual void BindPipeline(HgiComputePipelineHandle pipeline) = 0;
48
52 HGI_API
53 virtual void BindResources(HgiResourceBindingsHandle resources) = 0;
54
63 HGI_API
64 virtual void SetConstantValues(
66 uint32_t bindIndex,
67 uint32_t byteSize,
68 const void* data) = 0;
69
72 HGI_API
73 virtual void Dispatch(int dimX, int dimY) = 0;
74
77 HGI_API
78 virtual void InsertMemoryBarrier(HgiMemoryBarrier barrier) = 0;
79
81 HGI_API
82 virtual HgiComputeDispatch GetDispatchMethod() const = 0;
83
84protected:
85 HGI_API
87
88private:
89 HgiComputeCmds & operator=(const HgiComputeCmds&) = delete;
90 HgiComputeCmds(const HgiComputeCmds&) = delete;
91};
92
93
94
95PXR_NAMESPACE_CLOSE_SCOPE
96
97#endif
Graphics commands are recorded in 'cmds' objects which are later submitted to hgi.
Definition: cmds.h:28
A graphics API independent abstraction of compute commands.
Definition: computeCmds.h:29
virtual HGI_API void PushDebugGroup(const char *label)=0
Push a debug marker.
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 BindPipeline(HgiComputePipelineHandle pipeline)=0
Bind a pipeline state object.
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 PopDebugGroup()=0
Pop the last debug marker.
virtual HGI_API HgiComputeDispatch GetDispatchMethod() const =0
Returns the dispatch method for this encoder.
virtual HGI_API void BindResources(HgiResourceBindingsHandle resources)=0
Bind resources such as textures and uniform buffers.
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 comma...
Handle that contains a hgi object and unique id.
Definition: handle.h:33