All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
mixinShaderCode.h
1 //
2 // Copyright 2017 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 HDST_MIXIN_SHADER_CODE_H
25 #define HDST_MIXIN_SHADER_CODE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hdSt/shaderCode.h"
30 
31 PXR_NAMESPACE_OPEN_SCOPE
32 
40 class HdStMixinShaderCode final : public HdStShaderCode {
41 public:
42 
43  HDST_API
44  HdStMixinShaderCode(std::string mixinSource,
45  HdStShaderCodeSharedPtr baseShader);
46 
47  HDST_API
48  virtual ~HdStMixinShaderCode();
49 
51  virtual HdStShaderCode::ID ComputeHash() const override;
52 
55  virtual std::string GetSource(TfToken const &shaderStageKey) const override;
56 
57  virtual HdMaterialParamVector const& GetParams() const override;
58 
59  virtual HdStShaderCode::TextureDescriptorVector GetTextures() const override;
60 
63  virtual HdBufferArrayRangeSharedPtr const& GetShaderData() const override;
64 
66  virtual void BindResources(HdSt_ResourceBinder const &binder,
67  int program) override;
68 
70  virtual void UnbindResources(HdSt_ResourceBinder const &binder,
71  int program) override;
72 
74  virtual void AddBindings(HdBindingRequestVector* customBindings) override;
75 
77  HDST_API
78  virtual TfToken GetMaterialTag() const override;
79 
80 private:
81  std::string _mixinSource;
82  HdStShaderCodeSharedPtr _baseShader;
83 
84  HdStMixinShaderCode() = delete;
85  HdStMixinShaderCode(const HdStMixinShaderCode &) = delete;
86  HdStMixinShaderCode &operator =(const HdStMixinShaderCode &) = delete;
87 };
88 
89 
90 PXR_NAMESPACE_CLOSE_SCOPE
91 
92 #endif // HDST_SHADER_H
93 
virtual HDST_API TfToken GetMaterialTag() const
Material tags can be set in the meta-data of a glslfx file to control what rprim collection that prim...
virtual HDST_API HdBufferArrayRangeSharedPtr const & GetShaderData() const
Returns a buffer which stores parameter fallback values and texture handles.
virtual std::string GetSource(TfToken const &shaderStageKey) const =0
Returns the shader source provided by this shader for shaderStageKey.
virtual void AddBindings(HdBindingRequestVector *customBindings)=0
Add custom bindings (used by codegen)
virtual void UnbindResources(HdSt_ResourceBinder const &binder, int program)=0
Unbinds shader-specific resources.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
virtual void BindResources(HdSt_ResourceBinder const &binder, int program)=0
Binds shader-specific resources to program XXX: this interface is meant to be used for bridging the G...
virtual HDST_API HdMaterialParamVector const & GetParams() const
Returns the shader parameters for this shader.
A base class representing the implementation (code) of a shader, used in conjunction with HdRenderPas...
Definition: shaderCode.h:59
virtual ID ComputeHash() const =0
Returns the hash value of this shader.