HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderFunction.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_SHADERFUNCTION_H
25 #define PXR_IMAGING_HGIGL_SHADERFUNCTION_H
26 
28 
29 #include "pxr/imaging/hgiGL/api.h"
30 
32 
33 
34 ///
35 /// \class HgiGLShaderFunction
36 ///
37 /// OpenGL implementation of HgiShaderFunction
38 ///
40 {
41 public:
42  HGIGL_API
43  ~HgiGLShaderFunction() override;
44 
45  HGIGL_API
46  bool IsValid() const override;
47 
48  HGIGL_API
49  std::string const& GetCompileErrors() override;
50 
51  HGIGL_API
52  size_t GetByteSizeOfResource() const override;
53 
54  HGIGL_API
55  uint64_t GetRawResource() const override;
56 
57  /// Returns the gl resource id of the shader.
58  HGIGL_API
59  uint32_t GetShaderId() const;
60 
61 protected:
62  friend class HgiGL;
63 
64  HGIGL_API
66 
67 private:
68  HgiGLShaderFunction() = delete;
69  HgiGLShaderFunction & operator=(const HgiGLShaderFunction&) = delete;
71 
72 private:
73  std::string _errors;
74  uint32_t _shaderId;
75 };
76 
77 
79 
80 #endif
HGIGL_API ~HgiGLShaderFunction() override
HGIGL_API uint64_t GetRawResource() const override
HGIGL_API std::string const & GetCompileErrors() override
Returns shader compile errors.
HGIGL_API uint32_t GetShaderId() const
Returns the gl resource id of the shader.
Definition: hgi.h:53
#define HGIGL_API
Definition: api.h:40
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#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 size_t GetByteSizeOfResource() const override