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 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_GRAPHICS_CMDS_H
25 #define PXR_IMAGING_HGI_GRAPHICS_CMDS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/gf/vec4i.h"
29 #include "pxr/imaging/hgi/api.h"
33 #include "pxr/imaging/hgi/cmds.h"
34 #include <memory>
35 
37 
38 using HgiGraphicsCmdsUniquePtr = std::unique_ptr<class HgiGraphicsCmds>;
39 
40 
41 /// \class HgiGraphicsCmds
42 ///
43 /// A graphics API independent abstraction of graphics commands.
44 /// HgiGraphicsCmds is a lightweight object that cannot be re-used after it has
45 /// been submitted. A new cmds object should be acquired for each frame.
46 ///
47 class HgiGraphicsCmds : public HgiCmds
48 {
49 public:
50  HGI_API
51  ~HgiGraphicsCmds() override;
52 
53  /// Push a debug marker.
54  HGI_API
55  virtual void PushDebugGroup(const char* label) = 0;
56 
57  /// Pop the last debug marker.
58  HGI_API
59  virtual void PopDebugGroup() = 0;
60 
61  /// Set viewport [left, BOTTOM, width, height] - OpenGL coords
62  HGI_API
63  virtual void SetViewport(GfVec4i const& vp) = 0;
64 
65  /// Only pixels that lie within the scissor box are modified by
66  /// drawing commands.
67  HGI_API
68  virtual void SetScissor(GfVec4i const& sc) = 0;
69 
70  /// Bind a pipeline state object. Usually you call this right after calling
71  /// CreateGraphicsCmds to set the graphics pipeline state.
72  /// The resource bindings used when creating the pipeline must be compatible
73  /// with the resources bound via BindResources().
74  HGI_API
75  virtual void BindPipeline(HgiGraphicsPipelineHandle pipeline) = 0;
76 
77  /// Bind resources such as textures and uniform buffers.
78  /// Usually you call this right after BindPipeline() and the resources bound
79  /// must be compatible with the bound pipeline.
80  HGI_API
81  virtual void BindResources(HgiResourceBindingsHandle resources) = 0;
82 
83  /// Set Push / Function constants.
84  /// `pipeline` is the pipeline that you are binding before the draw call. It
85  /// contains the program used for the uniform buffer
86  /// `stages` describes for what shader stage you are setting the push
87  /// constant values for. Each stage can have its own (or none) binding
88  /// and they must match what is described in the shader functions.
89  /// `bindIndex` is the binding point index in the pipeline's shader
90  /// to bind the data to.
91  /// `byteSize` is the size of the data you are updating.
92  /// `data` is the data you are copying into the push constants block.
93  HGI_API
94  virtual void SetConstantValues(
97  uint32_t bindIndex,
98  uint32_t byteSize,
99  const void* data) = 0;
100 
101  /// Binds the vertex buffer(s) that describe the vertex attributes.
102  /// `firstBinding` the first index to which buffers are bound (usually 0).
103  /// `byteOffsets` offset to where the data of each buffer starts, in bytes.
104  /// `strides` the size of a vertex in each of the buffers.
105  HGI_API
106  virtual void BindVertexBuffers(
107  uint32_t firstBinding,
109  std::vector<uint32_t> const& byteOffsets) = 0;
110 
111  /// Records a draw command that renders one or more instances of primitives
112  /// using the number of vertices provided.
113  /// The 'primitive type' (eg. Lines, Triangles, etc) can be acquired from
114  /// the bound HgiPipeline.
115  /// `vertexCount`: The number of vertices to draw.
116  /// `firstVertex`: The index of the first vertex to draw.
117  /// `instanceCount`: Number of instances to draw.
118  HGI_API
119  virtual void Draw(
120  uint32_t vertexCount,
121  uint32_t firstVertex,
122  uint32_t instanceCount) = 0;
123 
124  /// Records a multi-draw command that reads the draw parameters
125  /// from a provided drawParameterBuffer.
126  /// The 'primitive type' (eg. Lines, Triangles, etc) can be acquired from
127  /// the bound HgiPipeline.
128  /// `drawParameterBuffer`: an array of structures:
129  // struct IndirectCommand {
130  // uint32_t vertexCount;
131  // uint32_t instanceCount;
132  // uint32_t firstVertex;
133  // uint32_t firstInstance;
134  // }
135  /// `drawBufferOffset`: Byte offset where the draw parameters begin.
136  /// `drawCount`: The number of draws to execute.
137  /// `stride`: byte stride between successive sets of draw parameters.
138  HGI_API
139  virtual void DrawIndirect(
140  HgiBufferHandle const& drawParameterBuffer,
141  uint32_t drawBufferOffset,
142  uint32_t drawCount,
143  uint32_t stride) = 0;
144 
145  /// Records a draw command that renders one or more instances of primitives
146  /// using an indexBuffer starting from the base vertex.
147  /// The 'primitive type' (eg. Lines, Triangles, etc) can be acquired from
148  /// the bound HgiPipeline.
149  /// `indexCount`: The number of indices in the index buffer (num vertices).
150  /// `indexBufferByteOffset`: Byte offset within index buffer to start
151  /// reading the indices from.
152  /// `vertexOffset`: The value added to the vertex index before indexing
153  /// into the vertex buffer (baseVertex).
154  /// `instanceCount`: Number of instances to draw.
155  HGI_API
156  virtual void DrawIndexed(
157  HgiBufferHandle const& indexBuffer,
158  uint32_t indexCount,
159  uint32_t indexBufferByteOffset,
160  uint32_t vertexOffset,
161  uint32_t instanceCount) = 0;
162 
163  /// Records a indexed multi-draw command that reads the draw parameters
164  /// from a provided drawParameterBuffer, and indices from indexBuffer.
165  /// The 'primitive type' (eg. Lines, Triangles, etc) can be acquired from
166  /// the bound HgiPipeline.
167  /// `drawParameterBuffer`: an array of structures:
168  // struct IndirectCommand {
169  // uint32_t indexCount;
170  // uint32_t instanceCount;
171  // uint32_t firstIndex;
172  // uint32_t vertexOffset;
173  // uint32_t firstInstance;
174  // }
175  /// `drawBufferOffset`: Byte offset where the draw parameters begin.
176  /// `drawCount`: The number of draws to execute.
177  /// `stride`: byte stride between successive sets of draw parameters.
178  HGI_API
179  virtual void DrawIndexedIndirect(
180  HgiBufferHandle const& indexBuffer,
181  HgiBufferHandle const& drawParameterBuffer,
182  uint32_t drawBufferOffset,
183  uint32_t drawCount,
184  uint32_t stride) = 0;
185 
186  /// Inserts a barrier so that data written to memory by commands before
187  /// the barrier is available to commands after the barrier.
188  HGI_API
189  virtual void MemoryBarrier(HgiMemoryBarrier barrier) = 0;
190 
191 protected:
192  HGI_API
193  HgiGraphicsCmds();
194 
195 private:
196  HgiGraphicsCmds & operator=(const HgiGraphicsCmds&) = delete;
197  HgiGraphicsCmds(const HgiGraphicsCmds&) = delete;
198 };
199 
200 
201 
203 
204 #endif
Definition: vec4i.h:61
const void GLsizei drawCount
Definition: glew.h:12498
virtual HGI_API void DrawIndirect(HgiBufferHandle const &drawParameterBuffer, uint32_t drawBufferOffset, uint32_t drawCount, uint32_t stride)=0
GLbitfield stages
Definition: glcorearb.h:1930
virtual HGI_API void SetScissor(GfVec4i const &sc)=0
virtual HGI_API void DrawIndexedIndirect(HgiBufferHandle const &indexBuffer, HgiBufferHandle const &drawParameterBuffer, uint32_t drawBufferOffset, uint32_t drawCount, uint32_t stride)=0
const GLuint * buffers
Definition: glcorearb.h:660
virtual HGI_API void BindResources(HgiResourceBindingsHandle resources)=0
virtual HGI_API void PopDebugGroup()=0
Pop the last debug marker.
virtual HGI_API void BindVertexBuffers(uint32_t firstBinding, HgiBufferHandleVector const &buffers, std::vector< uint32_t > const &byteOffsets)=0
virtual HGI_API void PushDebugGroup(const char *label)=0
Push a debug marker.
std::vector< HgiBufferHandle > HgiBufferHandleVector
Definition: buffer.h:152
HgiBits HgiMemoryBarrier
Definition: enums.h:538
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2544
GLboolean * data
Definition: glcorearb.h:130
HGI_API HgiGraphicsCmds()
virtual HGI_API void MemoryBarrier(HgiMemoryBarrier barrier)=0
#define HGI_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
virtual HGI_API void DrawIndexed(HgiBufferHandle const &indexBuffer, uint32_t indexCount, uint32_t indexBufferByteOffset, uint32_t vertexOffset, uint32_t instanceCount)=0
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
GLuint barrier
Definition: wglew.h:1077
HgiBits HgiShaderStage
Definition: enums.h:292
std::unique_ptr< class HgiGraphicsCmds > HgiGraphicsCmdsUniquePtr
Definition: graphicsCmds.h:38
GLint GLenum GLboolean GLsizei stride
Definition: glcorearb.h:871
virtual HGI_API void SetConstantValues(HgiGraphicsPipelineHandle pipeline, HgiShaderStage stages, uint32_t bindIndex, uint32_t byteSize, const void *data)=0
virtual HGI_API void BindPipeline(HgiGraphicsPipelineHandle pipeline)=0
virtual HGI_API void Draw(uint32_t vertexCount, uint32_t firstVertex, uint32_t instanceCount)=0
Definition: cmds.h:44
HGI_API ~HgiGraphicsCmds() override
virtual HGI_API void SetViewport(GfVec4i const &vp)=0
Set viewport [left, BOTTOM, width, height] - OpenGL coords.