HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
computeCmds.h
Go to the documentation of this file.
1 //
2 // Copyright 2020 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HGI_GL_COMPUTE_CMDS_H
25 #define PXR_IMAGING_HGI_GL_COMPUTE_CMDS_H
26 
27 #include "pxr/pxr.h"
30 #include "pxr/imaging/hgiGL/api.h"
31 #include "pxr/imaging/hgiGL/hgi.h"
32 #include <cstdint>
33 
35 
36 struct HgiComputeCmdsDesc;
37 
38 /// \class HgiGLComputeCmds
39 ///
40 /// OpenGL implementation of HgiComputeCmds.
41 ///
42 class HgiGLComputeCmds final : public HgiComputeCmds
43 {
44 public:
45  HGIGL_API
46  ~HgiGLComputeCmds() override;
47 
48  HGIGL_API
49  void PushDebugGroup(const char* label) override;
50 
51  HGIGL_API
52  void PopDebugGroup() override;
53 
54  HGIGL_API
55  void BindPipeline(HgiComputePipelineHandle pipeline) override;
56 
57  HGIGL_API
58  void BindResources(HgiResourceBindingsHandle resources) override;
59 
60  HGIGL_API
61  void SetConstantValues(
62  HgiComputePipelineHandle pipeline,
63  uint32_t bindIndex,
64  uint32_t byteSize,
65  const void* data) override;
66 
67  HGIGL_API
68  void Dispatch(int dimX, int dimY) override;
69 
70  HGIGL_API
71  void InsertMemoryBarrier(HgiMemoryBarrier barrier) override;
72 
73  HGIGL_API
74  HgiComputeDispatch GetDispatchMethod() const override;
75 
76 protected:
77  friend class HgiGL;
78 
79  HGIGL_API
80  HgiGLComputeCmds(HgiGLDevice* device, HgiComputeCmdsDesc const& desc);
81 
82  HGIGL_API
83  bool _Submit(Hgi* hgi, HgiSubmitWaitType wait) override;
84 
85 private:
86  HgiGLComputeCmds() = delete;
87  HgiGLComputeCmds & operator=(const HgiGLComputeCmds&) = delete;
88  HgiGLComputeCmds(const HgiGLComputeCmds&) = delete;
89 
90  HgiGLOpsVector _ops;
91  int _pushStack;
92  GfVec3i _localWorkGroupSize;
93 
94  // Cmds is used only one frame so storing multi-frame state on will not
95  // survive.
96 };
97 
99 
100 #endif
HGIGL_API void PushDebugGroup(const char *label) override
Push a debug marker.
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2545
HGIGL_API void InsertMemoryBarrier(HgiMemoryBarrier barrier) override
HGIGL_API void SetConstantValues(HgiComputePipelineHandle pipeline, uint32_t bindIndex, uint32_t byteSize, const void *data) override
HGIGL_API void BindPipeline(HgiComputePipelineHandle pipeline) override
HGIGL_API HgiComputeDispatch GetDispatchMethod() const override
Returns the dispatch method for this encoder.
HgiSubmitWaitType
Definition: enums.h:663
HGIGL_API void PopDebugGroup() override
Pop the last debug marker.
HgiComputeDispatch
Definition: enums.h:825
HGIGL_API void BindResources(HgiResourceBindingsHandle resources) override
HGIGL_API bool _Submit(Hgi *hgi, HgiSubmitWaitType wait) override
Definition: hgi.h:71
HgiBits HgiMemoryBarrier
Definition: enums.h:685
#define HGIGL_API
Definition: api.h:40
Definition: vec3i.h:60
*tasks wait()
Definition: hgi.h:110
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HGIGL_API ~HgiGLComputeCmds() override
std::vector< HgiGLOpsFn > HgiGLOpsVector
Definition: hgi.h:43
Definition: format.h:895
HGIGL_API void Dispatch(int dimX, int dimY) override