All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
graphicsEncoder.h
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_ENCODER_H
25 #define PXR_IMAGING_HGI_GRAPHICS_ENCODER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/gf/vec4i.h"
29 #include "pxr/imaging/hgi/api.h"
30 #include "pxr/imaging/hgi/pipeline.h"
31 #include "pxr/imaging/hgi/resourceBindings.h"
32 #include <memory>
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
36 using HgiGraphicsEncoderUniquePtr = std::unique_ptr<class HgiGraphicsEncoder>;
37 
38 
49 {
50 public:
51  HGI_API
52  virtual ~HgiGraphicsEncoder();
53 
55  HGI_API
56  virtual void Commit() = 0;
57 
59  HGI_API
60  virtual void SetViewport(GfVec4i const& vp) = 0;
61 
64  HGI_API
65  virtual void SetScissor(GfVec4i const& sc) = 0;
66 
71  HGI_API
72  virtual void BindPipeline(HgiPipelineHandle pipeline) = 0;
73 
77  HGI_API
78  virtual void BindResources(HgiResourceBindingsHandle resources) = 0;
79 
84  HGI_API
85  virtual void BindVertexBuffers(
86  uint32_t firstBinding,
87  HgiBufferHandleVector const& buffers,
88  std::vector<uint32_t> const& byteOffsets) = 0;
89 
98  HGI_API
99  virtual void DrawIndexed(
100  HgiBufferHandle const& indexBuffer,
101  uint32_t indexCount,
102  uint32_t indexBufferByteOffset,
103  uint32_t firstIndex,
104  uint32_t vertexOffset,
105  uint32_t instanceCount) = 0;
106 
108  HGI_API
109  virtual void PushDebugGroup(const char* label) = 0;
110 
112  HGI_API
113  virtual void PopDebugGroup() = 0;
114 
115 protected:
116  HGI_API
118 
119 private:
120  HgiGraphicsEncoder & operator=(const HgiGraphicsEncoder&) = delete;
121  HgiGraphicsEncoder(const HgiGraphicsEncoder&) = delete;
122 };
123 
124 
125 
126 PXR_NAMESPACE_CLOSE_SCOPE
127 
128 #endif
Basic type for a vector of 4 int components.
Definition: vec4i.h:61
virtual HGI_API void SetScissor(GfVec4i const &sc)=0
Only pixels that lie within the scissor box are modified by drawing commands.
virtual HGI_API void PopDebugGroup()=0
Pop the lastest debug marker off encoder.
virtual HGI_API void PushDebugGroup(const char *label)=0
Push a debug marker onto the encoder.
A graphics API independent abstraction of graphics commands.
virtual HGI_API void DrawIndexed(HgiBufferHandle const &indexBuffer, uint32_t indexCount, uint32_t indexBufferByteOffset, uint32_t firstIndex, uint32_t vertexOffset, uint32_t instanceCount)=0
Records a draw command that renders one or more instances of primitives using an indexBuffer starting...
virtual HGI_API void BindResources(HgiResourceBindingsHandle resources)=0
Bind resources such as textures and uniform buffers.
virtual HGI_API void SetViewport(GfVec4i const &vp)=0
Set viewport [left, BOTTOM, width, height] - OpenGL coords.
virtual HGI_API void Commit()=0
Finish recording of commands. No further commands can be recorded.
virtual HGI_API void BindPipeline(HgiPipelineHandle pipeline)=0
Bind a pipeline state object.
virtual HGI_API void BindVertexBuffers(uint32_t firstBinding, HgiBufferHandleVector const &buffers, std::vector< uint32_t > const &byteOffsets)=0
Binds the vertex buffer(s) that describe the vertex attributes.
Handle that contains a hgi object and unique id.
Definition: handle.h:49