All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderFunction.h
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 
27 #include "pxr/imaging/hgi/shaderFunction.h"
28 #include "pxr/imaging/hgiGL/api.h"
29 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
32 
39 {
40 public:
41  HGIGL_API
42  ~HgiGLShaderFunction() override;
43 
44  HGIGL_API
45  bool IsValid() const override;
46 
47  HGIGL_API
48  std::string const& GetCompileErrors() override;
49 
50  HGIGL_API
51  size_t GetByteSizeOfResource() const override;
52 
53  HGIGL_API
54  uint64_t GetRawResource() const override;
55 
57  HGIGL_API
58  uint32_t GetShaderId() const;
59 
60 protected:
61  friend class HgiGL;
62 
63  HGIGL_API
65 
66 private:
67  HgiGLShaderFunction() = delete;
68  HgiGLShaderFunction & operator=(const HgiGLShaderFunction&) = delete;
69  HgiGLShaderFunction(const HgiGLShaderFunction&) = delete;
70 
71 private:
72  std::string _errors;
73  uint32_t _shaderId;
74 };
75 
76 
77 PXR_NAMESPACE_CLOSE_SCOPE
78 
79 #endif
HGIGL_API std::string const & GetCompileErrors() override
Returns shader compile errors.
Represents one shader stage function (code snippet).
HGIGL_API size_t GetByteSizeOfResource() const override
Returns the byte size of the GPU shader function.
HGIGL_API bool IsValid() const override
Returns false if any shader compile errors occured.
OpenGL implementation of the Hydra Graphics Interface.
Definition: hgi.h:53
HGIGL_API uint64_t GetRawResource() const override
This function returns the handle to the Hgi backend's gpu resource, cast to a uint64_t.
HGIGL_API uint32_t GetShaderId() const
Returns the gl resource id of the shader.
OpenGL implementation of HgiShaderFunction.
Describes the properties needed to create a GPU shader function.