HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderGenerator.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 
25 #ifndef PXR_IMAGING_HGI_SHADERGENERATOR_H
26 #define PXR_IMAGING_HGI_SHADERGENERATOR_H
27 
28 #include "pxr/pxr.h"
29 #include "pxr/imaging/hgi/api.h"
30 #include "pxr/imaging/hgi/enums.h"
31 
32 #include <iosfwd>
33 #include <string>
34 
36 
38 
39 /// \class HgiShaderGenerator
40 ///
41 /// Base class for shader function generation
42 /// Given a descriptor, converts glslfx domain language to concrete shader
43 /// languages. Can be extended with new types of code sections and specialized
44 /// for different APIs. It's main role is to make GLSLFX a write once language,
45 /// no matter the API
46 ///
48 {
49 public:
50  //Write the generated code to the stringstream given once set up
51  HGI_API
52  void Execute(std::ostream &ss);
53 
54  HGI_API
55  virtual ~HgiShaderGenerator();
56 
57 protected:
58  HGI_API
59  explicit HgiShaderGenerator(const HgiShaderFunctionDesc &descriptor);
60 
61  HGI_API
62  virtual void _Execute(
63  std::ostream &ss,
64  const std::string &originalShaderCode) = 0;
65 
66  HGI_API
67  const std::string& _GetOriginalShader() const;
68 
69  HGI_API
71 
72  HGI_API
73  const std::string& _GetVersion() const;
74 
75 private:
76  HgiShaderGenerator() = delete;
77  HgiShaderGenerator & operator=(const HgiShaderGenerator&) = delete;
78  HgiShaderGenerator(const HgiShaderGenerator&) = delete;
79 
80  const std::string _version;
81  const std::string _originalShader;
82  const HgiShaderStage _stage;
83 };
84 
86 
87 #endif
HGI_API const std::string & _GetVersion() const
virtual HGI_API ~HgiShaderGenerator()
HGI_API const std::string & _GetOriginalShader() const
virtual HGI_API void _Execute(std::ostream &ss, const std::string &originalShaderCode)=0
HGI_API HgiShaderStage _GetShaderStage() const
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
#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
HgiBits HgiShaderStage
Definition: enums.h:292
HGI_API void Execute(std::ostream &ss)