Loading...
Searching...
No Matches
graphicsCmds.h
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_GRAPHICS_CMDS_H
8#define PXR_IMAGING_HGI_GRAPHICS_CMDS_H
9
10#include "pxr/pxr.h"
11#include "pxr/base/gf/vec4i.h"
12#include "pxr/imaging/hgi/api.h"
13#include "pxr/imaging/hgi/graphicsCmdsDesc.h"
14#include "pxr/imaging/hgi/graphicsPipeline.h"
15#include "pxr/imaging/hgi/resourceBindings.h"
16#include "pxr/imaging/hgi/cmds.h"
17#include <memory>
18
19PXR_NAMESPACE_OPEN_SCOPE
20
21using HgiGraphicsCmdsUniquePtr = std::unique_ptr<class HgiGraphicsCmds>;
22
23
30class HgiGraphicsCmds : public HgiCmds
31{
32public:
33 HGI_API
34 ~HgiGraphicsCmds() override;
35
37 HGI_API
38 virtual void PushDebugGroup(const char* label) = 0;
39
41 HGI_API
42 virtual void PopDebugGroup() = 0;
43
45 HGI_API
46 virtual void SetViewport(GfVec4i const& vp) = 0;
47
50 HGI_API
51 virtual void SetScissor(GfVec4i const& sc) = 0;
52
57 HGI_API
58 virtual void BindPipeline(HgiGraphicsPipelineHandle pipeline) = 0;
59
63 HGI_API
64 virtual void BindResources(HgiResourceBindingsHandle resources) = 0;
65
76 HGI_API
77 virtual void SetConstantValues(
78 HgiGraphicsPipelineHandle pipeline,
79 HgiShaderStage stages,
80 uint32_t bindIndex,
81 uint32_t byteSize,
82 const void* data) = 0;
83
85 HGI_API
86 virtual void BindVertexBuffers(
87 HgiVertexBufferBindingVector const &bindings) = 0;
88
97 HGI_API
98 virtual void Draw(
99 uint32_t vertexCount,
100 uint32_t baseVertex,
101 uint32_t instanceCount,
102 uint32_t baseInstance) = 0;
103
109 // struct IndirectCommand {
110 // uint32_t vertexCount;
111 // uint32_t instanceCount;
112 // uint32_t baseVertex;
113 // uint32_t baseInstance;
114 // }
118 HGI_API
119 virtual void DrawIndirect(
120 HgiBufferHandle const& drawParameterBuffer,
121 uint32_t drawBufferByteOffset,
122 uint32_t drawCount,
123 uint32_t stride) = 0;
124
136 HGI_API
137 virtual void DrawIndexed(
138 HgiBufferHandle const& indexBuffer,
139 uint32_t indexCount,
140 uint32_t indexBufferByteOffset,
141 uint32_t baseVertex,
142 uint32_t instanceCount,
143 uint32_t baseInstance) = 0;
144
151 // struct IndirectCommand {
152 // uint32_t indexCount;
153 // uint32_t instanceCount;
154 // uint32_t baseIndex;
155 // uint32_t baseVertex;
156 // uint32_t baseInstance;
157 // }
158 // struct MetalPatchIndirectCommand {
159 // uint32_t patchCount;
160 // uint32_t instanceCount;
161 // uint32_t patchStart;
162 // uint32_t baseInstance;
163 // }
174 HGI_API
175 virtual void DrawIndexedIndirect(
176 HgiBufferHandle const& indexBuffer,
177 HgiBufferHandle const& drawParameterBuffer,
178 uint32_t drawBufferByteOffset,
179 uint32_t drawCount,
180 uint32_t stride,
181 std::vector<uint32_t> const& drawParameterBufferUInt32,
182 uint32_t patchBaseVertexByteOffset) = 0;
183
186 HGI_API
187 virtual void InsertMemoryBarrier(HgiMemoryBarrier barrier) = 0;
188
189protected:
190 HGI_API
191 HgiGraphicsCmds();
192
193private:
194 HgiGraphicsCmds & operator=(const HgiGraphicsCmds&) = delete;
195 HgiGraphicsCmds(const HgiGraphicsCmds&) = delete;
196};
197
198
199
200PXR_NAMESPACE_CLOSE_SCOPE
201
202#endif
GfVec4i
Basic type for a vector of 4 int components.
Definition: vec4i.h:44
HgiCmds
Graphics commands are recorded in 'cmds' objects which are later submitted to hgi.
Definition: cmds.h:28
HgiGraphicsCmds
A graphics API independent abstraction of graphics commands.
Definition: graphicsCmds.h:31
HgiGraphicsCmds::BindVertexBuffers
virtual HGI_API void BindVertexBuffers(HgiVertexBufferBindingVector const &bindings)=0
Binds the vertex buffer(s) that describe the vertex attributes.
HgiGraphicsCmds::SetViewport
virtual HGI_API void SetViewport(GfVec4i const &vp)=0
Set viewport [left, BOTTOM, width, height] - OpenGL coords.
HgiGraphicsCmds::DrawIndexed
virtual HGI_API void DrawIndexed(HgiBufferHandle const &indexBuffer, uint32_t indexCount, uint32_t indexBufferByteOffset, uint32_t baseVertex, uint32_t instanceCount, uint32_t baseInstance)=0
Records a draw command that renders one or more instances of primitives using an indexBuffer starting...
HgiGraphicsCmds::BindPipeline
virtual HGI_API void BindPipeline(HgiGraphicsPipelineHandle pipeline)=0
Bind a pipeline state object.
HgiGraphicsCmds::PushDebugGroup
virtual HGI_API void PushDebugGroup(const char *label)=0
Push a debug marker.
HgiGraphicsCmds::Draw
virtual HGI_API void Draw(uint32_t vertexCount, uint32_t baseVertex, uint32_t instanceCount, uint32_t baseInstance)=0
Records a draw command that renders one or more instances of primitives using the number of vertices ...
HgiGraphicsCmds::PopDebugGroup
virtual HGI_API void PopDebugGroup()=0
Pop the last debug marker.
HgiGraphicsCmds::SetConstantValues
virtual HGI_API void SetConstantValues(HgiGraphicsPipelineHandle pipeline, HgiShaderStage stages, uint32_t bindIndex, uint32_t byteSize, const void *data)=0
Set Push / Function constants.
HgiGraphicsCmds::SetScissor
virtual HGI_API void SetScissor(GfVec4i const &sc)=0
Only pixels that lie within the scissor box are modified by drawing commands.
HgiGraphicsCmds::DrawIndirect
virtual HGI_API void DrawIndirect(HgiBufferHandle const &drawParameterBuffer, uint32_t drawBufferByteOffset, uint32_t drawCount, uint32_t stride)=0
Records a multi-draw command that reads the draw parameters from a provided drawParameterBuffer.
HgiGraphicsCmds::DrawIndexedIndirect
virtual HGI_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)=0
Records a indexed multi-draw command that reads the draw parameters from a provided drawParameterBuff...
HgiGraphicsCmds::BindResources
virtual HGI_API void BindResources(HgiResourceBindingsHandle resources)=0
Bind resources such as textures and uniform buffers.
HgiGraphicsCmds::InsertMemoryBarrier
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...