HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ops.h
Go to the documentation of this file.
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_HGIGL_OPS_H
8 #define PXR_IMAGING_HGIGL_OPS_H
9 
10 #include "pxr/pxr.h"
11 #include "pxr/base/gf/vec4i.h"
12 
13 #include "pxr/imaging/hgi/buffer.h"
18 
19 #include "pxr/imaging/hgiGL/api.h"
21 
22 #include <cstdint>
23 #include <functional>
24 #include <vector>
25 
27 
28 using HgiGLOpsFn = std::function<void(void)>;
29 
30 /// \class HgiGLOps
31 ///
32 /// A collection of functions used by cmds objects to do deferred cmd recording.
33 /// Modern API's support command buffer recording of gfx commands ('deferred').
34 /// Meaning: No commands are executed on the GPU until we Submit the cmd buffer.
35 ///
36 /// OpenGL uses 'immediate' mode instead where gfx commands are immediately
37 /// processed and given to the GPU at a time of the drivers choosing.
38 /// We use 'Ops' functions to record our OpenGL function in a list and only
39 /// execute them in OpenGL during the SubmitCmds phase.
40 ///
41 /// This has two benefits:
42 ///
43 /// 1. OpenGL behaves more like Metal and Vulkan. So when clients write Hgi code
44 /// they get similar behavior in gpu command execution across all backends.
45 /// For example, if you are running with HgiGL and recording commands into a
46 /// Hgi***Cmds object and forget to call 'SubmitCmds' you will notice that
47 /// your commands are not executed on the GPU, just like what would happen if
48 /// you were running with HgiMetal.
49 ///
50 /// 2. It lets us satisfy the Hgi requirement that Hgi***Cmds objects must be
51 /// able to do their recording on secondary threads.
52 ///
53 class HgiGLOps
54 {
55 public:
56  HGIGL_API
57  static HgiGLOpsFn PushDebugGroup(const char* label);
58 
59  HGIGL_API
60  static HgiGLOpsFn PopDebugGroup();
61 
62  HGIGL_API
64 
65  HGIGL_API
67 
68  HGIGL_API
70 
71  HGIGL_API
73 
74  HGIGL_API
76 
77  HGIGL_API
79 
80  HGIGL_API
82 
83  HGIGL_API
85  HgiGLDevice* device,
86  HgiGraphicsCmdsDesc const &graphicsCmds);
87 
88  HGIGL_API
89  static HgiGLOpsFn SetViewport(GfVec4i const& vp);
90 
91  HGIGL_API
92  static HgiGLOpsFn SetScissor(GfVec4i const& sc);
93 
94  HGIGL_API
96 
97  HGIGL_API
99 
100  HGIGL_API
102 
103  HGIGL_API
105  HgiGraphicsPipelineHandle pipeline,
107  uint32_t bindIndex,
108  uint32_t byteSize,
109  const void* data);
110 
111  HGIGL_API
113  HgiComputePipelineHandle pipeline,
114  uint32_t bindIndex,
115  uint32_t byteSize,
116  const void* data);
117 
118  HGIGL_API
120  HgiVertexBufferBindingVector const &bindings);
121 
122  HGIGL_API
123  static HgiGLOpsFn Draw(
124  HgiPrimitiveType primitiveType,
125  uint32_t primitiveIndexSize,
126  uint32_t vertexCount,
127  uint32_t baseVertex,
128  uint32_t instanceCount,
129  uint32_t baseInstance);
130 
131  HGIGL_API
132  static HgiGLOpsFn DrawIndirect(
133  HgiPrimitiveType primitiveType,
134  uint32_t primitiveIndexSize,
135  HgiBufferHandle const& drawParameterBuffer,
136  uint32_t drawBufferByteOffset,
137  uint32_t drawCount,
138  uint32_t stride);
139 
140  HGIGL_API
141  static HgiGLOpsFn DrawIndexed(
142  HgiPrimitiveType primitiveType,
143  uint32_t primitiveIndexSize,
144  HgiBufferHandle const& indexBuffer,
145  uint32_t indexCount,
146  uint32_t indexBufferByteOffset,
147  uint32_t baseVertex,
148  uint32_t instanceCount,
149  uint32_t baseInstance);
150 
151  HGIGL_API
153  HgiPrimitiveType primitiveType,
154  uint32_t primitiveIndexSize,
155  HgiBufferHandle const& indexBuffer,
156  HgiBufferHandle const& drawParameterBuffer,
157  uint32_t drawBufferByteOffset,
158  uint32_t drawCount,
159  uint32_t stride);
160 
161  HGIGL_API
163  HgiGLDevice* device,
164  HgiGraphicsCmdsDesc const& desc);
165 
166  HGIGL_API
167  static HgiGLOpsFn Dispatch(int dimX, int dimY);
168 
169  HGIGL_API
170  static HgiGLOpsFn FillBuffer(HgiBufferHandle const& buffer, uint8_t value);
171 
172  HGIGL_API
174 
175  HGIGL_API
177 
178 };
179 
181 
182 #endif
Definition: vec4i.h:43
static HGIGL_API HgiGLOpsFn CopyBufferToTexture(HgiBufferToTextureOp const &copyOp)
static HGIGL_API HgiGLOpsFn BindResources(HgiResourceBindingsHandle resources)
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2545
GLbitfield stages
Definition: glcorearb.h:1931
GLsizei const GLfloat * value
Definition: glcorearb.h:824
static HGIGL_API HgiGLOpsFn CopyTextureToBuffer(HgiTextureToBufferOp const &copyOp)
std::function< void(void)> HgiGLOpsFn
Definition: hgi.h:25
static HGIGL_API HgiGLOpsFn CopyBufferGpuToGpu(HgiBufferGpuToGpuOp const &copyOp)
static HGIGL_API HgiGLOpsFn ResolveFramebuffer(HgiGLDevice *device, HgiGraphicsCmdsDesc const &graphicsCmds)
int HgiHandle< class HgiTexture > HgiTextureHandle
static HGIGL_API HgiGLOpsFn CopyTextureGpuToCpu(HgiTextureGpuToCpuOp const &copyOp)
GLuint buffer
Definition: glcorearb.h:660
static HGIGL_API HgiGLOpsFn CopyTextureCpuToGpu(HgiTextureCpuToGpuOp const &copyOp)
std::vector< HgiVertexBufferBinding > HgiVertexBufferBindingVector
static HGIGL_API HgiGLOpsFn PopDebugGroup()
static HGIGL_API HgiGLOpsFn PushDebugGroup(const char *label)
static HGIGL_API HgiGLOpsFn GenerateMipMaps(HgiTextureHandle const &texture)
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
static HGIGL_API HgiGLOpsFn DrawIndexedIndirect(HgiPrimitiveType primitiveType, uint32_t primitiveIndexSize, HgiBufferHandle const &indexBuffer, HgiBufferHandle const &drawParameterBuffer, uint32_t drawBufferByteOffset, uint32_t drawCount, uint32_t stride)
static HGIGL_API HgiGLOpsFn Dispatch(int dimX, int dimY)
static HGIGL_API HgiGLOpsFn DrawIndirect(HgiPrimitiveType primitiveType, uint32_t primitiveIndexSize, HgiBufferHandle const &drawParameterBuffer, uint32_t drawBufferByteOffset, uint32_t drawCount, uint32_t stride)
static HGIGL_API HgiGLOpsFn SetScissor(GfVec4i const &sc)
static HGIGL_API HgiGLOpsFn InsertMemoryBarrier(HgiMemoryBarrier barrier)
static HGIGL_API HgiGLOpsFn DrawIndexed(HgiPrimitiveType primitiveType, uint32_t primitiveIndexSize, HgiBufferHandle const &indexBuffer, uint32_t indexCount, uint32_t indexBufferByteOffset, uint32_t baseVertex, uint32_t instanceCount, uint32_t baseInstance)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
static HGIGL_API HgiGLOpsFn CopyBufferGpuToCpu(HgiBufferGpuToCpuOp const &copyOp)
static HGIGL_API HgiGLOpsFn CopyBufferCpuToGpu(HgiBufferCpuToGpuOp const &copyOp)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
static HGIGL_API HgiGLOpsFn FillBuffer(HgiBufferHandle const &buffer, uint8_t value)
static HGIGL_API HgiGLOpsFn SetConstantValues(HgiGraphicsPipelineHandle pipeline, HgiShaderStage stages, uint32_t bindIndex, uint32_t byteSize, const void *data)
HgiBits HgiShaderStage
Definition: enums.h:357
GLuint texture
Definition: glcorearb.h:415
static HGIGL_API HgiGLOpsFn BindVertexBuffers(HgiVertexBufferBindingVector const &bindings)
static HGIGL_API HgiGLOpsFn BindPipeline(HgiGraphicsPipelineHandle pipeline)
static HGIGL_API HgiGLOpsFn SetViewport(GfVec4i const &vp)
static HGIGL_API HgiGLOpsFn Draw(HgiPrimitiveType primitiveType, uint32_t primitiveIndexSize, uint32_t vertexCount, uint32_t baseVertex, uint32_t instanceCount, uint32_t baseInstance)
static HGIGL_API HgiGLOpsFn BindFramebufferOp(HgiGLDevice *device, HgiGraphicsCmdsDesc const &desc)
Definition: format.h:1821
Definition: ops.h:53