HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
graphicsCmds.h
Go to the documentation of this file.
1 //
2 // Copyright 2019 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_GL_GRAPHICS_CMDS_H
8 #define PXR_IMAGING_HGI_GL_GRAPHICS_CMDS_H
9 
10 #include "pxr/pxr.h"
11 #include "pxr/base/gf/vec4i.h"
13 #include "pxr/imaging/hgiGL/api.h"
14 #include "pxr/imaging/hgiGL/hgi.h"
15 #include <cstdint>
16 
18 
19 struct HgiGraphicsCmdsDesc;
20 class HgiGLDevice;
21 
22 /// \class HgiGLGraphicsCmds
23 ///
24 /// OpenGL implementation of HgiGraphicsCmds.
25 ///
26 class HgiGLGraphicsCmds final : public HgiGraphicsCmds
27 {
28 public:
29  HGIGL_API
30  ~HgiGLGraphicsCmds() override;
31 
32  /// XXX This function is exposed temporarily for Hgi transition.
33  /// It allows code that is not yet converted to Hgi (e.g. HdSt) to insert
34  /// its opengl calls into the ops-stack of HgiGL to ensure that all commands
35  /// execute in the correct order. Once HdSt has transition fully to Hgi we
36  /// should remove this function.
37  HGIGL_API
38  void InsertFunctionOp(std::function<void(void)> const& fn);
39 
40  HGIGL_API
41  void PushDebugGroup(const char* label) override;
42 
43  HGIGL_API
44  void PopDebugGroup() override;
45 
46  HGIGL_API
47  void SetViewport(GfVec4i const& vp) override;
48 
49  HGIGL_API
50  void SetScissor(GfVec4i const& sc) override;
51 
52  HGIGL_API
53  void BindPipeline(HgiGraphicsPipelineHandle pipeline) override;
54 
55  HGIGL_API
56  void BindResources(HgiResourceBindingsHandle resources) override;
57 
58  HGIGL_API
59  void SetConstantValues(
62  uint32_t bindIndex,
63  uint32_t byteSize,
64  const void* data) override;
65 
66  HGIGL_API
67  void BindVertexBuffers(
68  HgiVertexBufferBindingVector const &bindings) override;
69 
70  HGIGL_API
71  void Draw(
72  uint32_t vertexCount,
73  uint32_t baseVertex,
74  uint32_t instanceCount,
75  uint32_t baseInstance) override;
76 
77  HGIGL_API
78  void DrawIndirect(
79  HgiBufferHandle const& drawParameterBuffer,
80  uint32_t drawBufferByteOffset,
81  uint32_t drawCount,
82  uint32_t stride) override;
83 
84  HGIGL_API
85  void DrawIndexed(
86  HgiBufferHandle const& indexBuffer,
87  uint32_t indexCount,
88  uint32_t indexBufferByteOffset,
89  uint32_t baseVertex,
90  uint32_t instanceCount,
91  uint32_t baseInstance) override;
92 
93  HGIGL_API
95  HgiBufferHandle const& indexBuffer,
96  HgiBufferHandle const& drawParameterBuffer,
97  uint32_t drawBufferByteOffset,
98  uint32_t drawCount,
99  uint32_t stride,
100  std::vector<uint32_t> const& drawParameterBufferUInt32,
101  uint32_t patchBaseVertexByteOffset) override;
102 
103  HGIGL_API
104  void InsertMemoryBarrier(HgiMemoryBarrier barrier) override;
105 
106 protected:
107  friend class HgiGL;
108 
109  HGIGL_API
111  HgiGLDevice* device,
112  HgiGraphicsCmdsDesc const& desc);
113 
114  HGIGL_API
115  bool _Submit(Hgi* hgi, HgiSubmitWaitType wait) override;
116 
117 private:
118  HgiGLGraphicsCmds() = delete;
119  HgiGLGraphicsCmds & operator=(const HgiGLGraphicsCmds&) = delete;
120  HgiGLGraphicsCmds(const HgiGLGraphicsCmds&) = delete;
121 
122  /// This performs multisample resolve when needed at the end of recording.
123  void _AddResolveToOps(HgiGLDevice* device);
124 
125  bool _recording;
126  HgiGraphicsCmdsDesc _descriptor;
127  HgiPrimitiveType _primitiveType;
128  int _primitiveIndexSize;
129  HgiGLOpsVector _ops;
130  int _pushStack;
131  int32_t _restoreReadFramebuffer;
132  int32_t _restoreDrawFramebuffer;
133 
134  // Cmds is used only one frame so storing multi-frame state on will not
135  // survive.
136 };
137 
139 
140 #endif
Definition: vec4i.h:43
HGIGL_API void SetConstantValues(HgiGraphicsPipelineHandle pipeline, HgiShaderStage stages, uint32_t bindIndex, uint32_t byteSize, const void *data) override
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2545
GLbitfield stages
Definition: glcorearb.h:1931
HGIGL_API void PushDebugGroup(const char *label) override
Push a debug marker.
HGIGL_API void Draw(uint32_t vertexCount, uint32_t baseVertex, uint32_t instanceCount, uint32_t baseInstance) override
HGIGL_API void SetScissor(GfVec4i const &sc) override
HGIGL_API void DrawIndexedIndirect(HgiBufferHandle const &indexBuffer, HgiBufferHandle const &drawParameterBuffer, uint32_t drawBufferByteOffset, uint32_t drawCount, uint32_t stride, std::vector< uint32_t > const &drawParameterBufferUInt32, uint32_t patchBaseVertexByteOffset) override
HGIGL_API void BindVertexBuffers(HgiVertexBufferBindingVector const &bindings) override
Binds the vertex buffer(s) that describe the vertex attributes.
HGIGL_API bool _Submit(Hgi *hgi, HgiSubmitWaitType wait) override
HgiSubmitWaitType
Definition: enums.h:650
std::vector< HgiVertexBufferBinding > HgiVertexBufferBindingVector
Definition: hgi.h:54
HgiBits HgiMemoryBarrier
Definition: enums.h:672
GLint GLenum GLboolean GLsizei stride
Definition: glcorearb.h:872
#define HGIGL_API
Definition: api.h:23
HgiPrimitiveType
Definition: enums.h:596
HGIGL_API void BindPipeline(HgiGraphicsPipelineHandle pipeline) override
HGIGL_API ~HgiGLGraphicsCmds() override
HGIGL_API void PopDebugGroup() override
Pop the last debug marker.
*tasks wait()
Definition: hgi.h:93
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
HGIGL_API void DrawIndirect(HgiBufferHandle const &drawParameterBuffer, uint32_t drawBufferByteOffset, uint32_t drawCount, uint32_t stride) override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
HGIGL_API void InsertFunctionOp(std::function< void(void)> const &fn)
HgiBits HgiShaderStage
Definition: enums.h:357
HGIGL_API void BindResources(HgiResourceBindingsHandle resources) override
std::vector< HgiGLOpsFn > HgiGLOpsVector
Definition: hgi.h:26
HGIGL_API void SetViewport(GfVec4i const &vp) override
Set viewport [left, BOTTOM, width, height] - OpenGL coords.
HGIGL_API void InsertMemoryBarrier(HgiMemoryBarrier barrier) override
HGIGL_API void DrawIndexed(HgiBufferHandle const &indexBuffer, uint32_t indexCount, uint32_t indexBufferByteOffset, uint32_t baseVertex, uint32_t instanceCount, uint32_t baseInstance) override
Definition: format.h:1821