HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
computePipeline.h
Go to the documentation of this file.
1 //
2 // Copyright 2020 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_COMPUTE_PIPELINE_H
25 #define PXR_IMAGING_HGI_COMPUTE_PIPELINE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hgi/api.h"
30 #include "pxr/imaging/hgi/enums.h"
31 #include "pxr/imaging/hgi/handle.h"
34 #include "pxr/imaging/hgi/types.h"
35 
36 #include <string>
37 #include <vector>
38 
40 
41 
42 /// \struct HgiComputeShaderConstantsDesc
43 ///
44 /// A small, but fast buffer of uniform data for shaders.
45 ///
46 /// <ul>
47 /// <li>byteSize:
48 /// Size of the constants in bytes. (max 256 bytes)</li>
49 /// </ul>
50 ///
52  HGI_API
54 
55  uint32_t byteSize;
56 };
57 
58 HGI_API
59 bool operator==(
62 
63 HGI_API
64 bool operator!=(
67 
68 /// \struct HgiComputePipelineDesc
69 ///
70 /// Describes the properties needed to create a GPU compute pipeline.
71 ///
72 /// <ul>
73 /// <li>shaderProgram:
74 /// Shader function used in this pipeline.</li>
75 /// <li>shaderConstantsDesc:
76 /// Describes the shader uniforms.</li>
77 /// </ul>
78 ///
80 {
81  HGI_API
83 
87 };
88 
89 HGI_API
90 bool operator==(
91  const HgiComputePipelineDesc& lhs,
92  const HgiComputePipelineDesc& rhs);
93 
94 HGI_API
95 bool operator!=(
96  const HgiComputePipelineDesc& lhs,
97  const HgiComputePipelineDesc& rhs);
98 
99 
100 ///
101 /// \class HgiComputePipeline
102 ///
103 /// Represents a graphics platform independent GPU compute pipeline resource.
104 ///
105 /// Base class for Hgi compute pipelines.
106 /// To the client (HdSt) compute pipeline resources are referred to via
107 /// opaque, stateless handles (HgiComputePipelineHandle).
108 ///
110 {
111 public:
112  HGI_API
113  virtual ~HgiComputePipeline();
114 
115  /// The descriptor describes the object.
116  HGI_API
117  HgiComputePipelineDesc const& GetDescriptor() const;
118 
119 protected:
120  HGI_API
122 
124 
125 private:
126  HgiComputePipeline() = delete;
127  HgiComputePipeline & operator=(const HgiComputePipeline&) = delete;
128  HgiComputePipeline(const HgiComputePipeline&) = delete;
129 };
130 
132 using HgiComputePipelineHandleVector = std::vector<HgiComputePipelineHandle>;
133 
134 
136 
137 #endif
HgiShaderProgramHandle shaderProgram
virtual HGI_API ~HgiComputePipeline()
HgiComputePipelineDesc _descriptor
HgiComputeShaderConstantsDesc shaderConstantsDesc
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:570
#define HGI_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::vector< HgiComputePipelineHandle > HgiComputePipelineHandleVector
HGI_API HgiComputePipelineDesc()
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:556
HGI_API HgiComputePipelineDesc const & GetDescriptor() const
The descriptor describes the object.