HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderProgram.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_HGIGL_SHADERPROGRAM_H
25 #define PXR_IMAGING_HGIGL_SHADERPROGRAM_H
26 
28 
29 #include "pxr/imaging/hgiGL/api.h"
31 
32 #include <vector>
33 
35 
36 
37 ///
38 /// \class HgiGLShaderProgram
39 ///
40 /// OpenGL implementation of HgiShaderProgram
41 ///
43 {
44 public:
45  HGIGL_API
46  ~HgiGLShaderProgram() override;
47 
48  HGIGL_API
49  bool IsValid() const override;
50 
51  HGIGL_API
52  std::string const& GetCompileErrors() override;
53 
54  HGIGL_API
55  HgiShaderFunctionHandleVector const& GetShaderFunctions() const override;
56 
57  HGIGL_API
58  size_t GetByteSizeOfResource() const override;
59 
60  HGIGL_API
61  uint64_t GetRawResource() const override;
62 
63  /// Returns the gl resource id of the program.
64  HGIGL_API
65  uint32_t GetProgramId() const;
66 
67  /// Returns the gl resource for the uniform block of this shader program.
68  /// This uniform block is used to store some per-shader values, such as
69  /// indices or offsets into other buffers.
70  /// See also Hgi::SetConstantValues.
71  /// 'sizeHint' is used to store the byte size of the uniform buffer, but
72  /// this fn does not actually allocate the data storage for the buffer.
73  HGIGL_API
74  uint32_t GetUniformBuffer(size_t sizeHint);
75 
76 protected:
77  friend class HgiGL;
78 
79  HGIGL_API
81 
82 private:
83  HgiGLShaderProgram() = delete;
84  HgiGLShaderProgram & operator=(const HgiGLShaderProgram&) = delete;
85  HgiGLShaderProgram(const HgiGLShaderProgram&) = delete;
86 
87 private:
88  std::string _errors;
89  uint32_t _programId;
90  size_t _programByteSize;
91  uint32_t _uniformBuffer;
92  size_t _uboByteSize;
93 };
94 
95 
97 
98 #endif
HGIGL_API std::string const & GetCompileErrors() override
Returns shader compile errors.
HGIGL_API size_t GetByteSizeOfResource() const override
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
std::vector< HgiShaderFunctionHandle > HgiShaderFunctionHandleVector
Definition: hgi.h:71
#define HGIGL_API
Definition: api.h:40
HGIGL_API uint64_t GetRawResource() const override
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
HGIGL_API uint32_t GetProgramId() const
Returns the gl resource id of the program.
HGIGL_API ~HgiGLShaderProgram() override
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HGIGL_API bool IsValid() const override
Returns false if any shader compile errors occured.
HGIGL_API uint32_t GetUniformBuffer(size_t sizeHint)
HGIGL_API HgiShaderFunctionHandleVector const & GetShaderFunctions() const override
Returns the shader functions that are part of this program.