Loading...
Searching...
No Matches
shaderGenerator.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
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
35PXR_NAMESPACE_OPEN_SCOPE
36
38
48{
49public:
50 HGI_API
51 virtual ~HgiShaderGenerator();
52
53 // Execute shader generation.
54 HGI_API
55 void Execute();
56
57 // Return generated shader source.
58 HGI_API
59 const char *GetGeneratedShaderCode() const;
60
61protected:
62 HGI_API
63 explicit HgiShaderGenerator(const HgiShaderFunctionDesc &descriptor);
64
65 HGI_API
66 virtual void _Execute(std::ostream &ss) = 0;
67
68 HGI_API
69 const char *_GetShaderCodeDeclarations() const;
70
71 HGI_API
72 const char *_GetShaderCode() const;
73
74 HGI_API
75 HgiShaderStage _GetShaderStage() const;
76
77private:
78 const HgiShaderFunctionDesc &_descriptor;
79
80 // This is used if the descriptor does not specify a string
81 // to be used as the destination for generated output.
82 std::string _localGeneratedShaderCode;
83
84 HgiShaderGenerator() = delete;
85 HgiShaderGenerator & operator=(const HgiShaderGenerator&) = delete;
87};
88
89PXR_NAMESPACE_CLOSE_SCOPE
90
91#endif
Base class for shader function generation Given a descriptor, converts glslfx domain language to conc...
Describes the properties needed to create a GPU shader function.