HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderPassShader.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 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_HD_ST_RENDER_PASS_SHADER_H
25 #define PXR_IMAGING_HD_ST_RENDER_PASS_SHADER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/enums.h"
30 #include "pxr/imaging/hd/binding.h"
32 #include "pxr/imaging/hio/glslfx.h"
33 
35 #include "pxr/base/tf/token.h"
36 
37 #include <memory>
38 
40 
42  std::shared_ptr<class HdStRenderPassShader>;
43 class HdRenderIndex;
45  std::vector<struct HdRenderPassAovBinding>;
46 
47 /// \class HdStRenderPassShader
48 ///
49 /// A shader that supports common renderPass functionality.
50 ///
52 public:
53  HDST_API
55  HDST_API
56  HdStRenderPassShader(TfToken const &glslfxFile);
57  HDST_API
58  ~HdStRenderPassShader() override;
59 
60  /// HdShader overrides
61  HDST_API
62  ID ComputeHash() const override;
63  HDST_API
64  std::string GetSource(TfToken const &shaderStageKey) const override;
65  HDST_API
66  void BindResources(int program,
67  HdSt_ResourceBinder const &binder) override;
68  HDST_API
69  void UnbindResources(int program,
70  HdSt_ResourceBinder const &binder) override;
71  HDST_API
72  void AddBindings(HdBindingRequestVector *customBindings) override;
73  HDST_API
74  HdSt_MaterialParamVector const& GetParams() const override;
75 
76  HDST_API
77  NamedTextureHandleVector const & GetNamedTextureHandles() const override;
78 
79  /// Add a custom binding request for use when this shader executes.
80  HDST_API
81  void AddBufferBinding(HdBindingRequest const& req);
82 
83  /// Remove \p name from custom binding.
84  HDST_API
85  void RemoveBufferBinding(TfToken const &name);
86 
87  /// Clear all custom bindings associated with this shader.
88  HDST_API
89  void ClearBufferBindings();
90 
91  // Sets the textures and params such that the shader can access
92  // the requested aovs with HdGet_AOVNAMEReadback().
93  //
94  // Needs to be called in task prepare or sync since it is
95  // allocating texture handles.
96  //
97  HDST_API
99  HdRenderPassAovBindingVector const &aovInputBindings,
100  HdRenderIndex * const renderIndex);
101 
102 private:
103  TfToken _glslfxFile;
104  std::unique_ptr<HioGlslfx> _glslfx;
105  mutable size_t _hash;
106  mutable bool _hashValid;
107 
109 
110  NamedTextureHandleVector _namedTextureHandles;
111 
112  HdSt_MaterialParamVector _params;
113 
114  // No copying
115  HdStRenderPassShader(const HdStRenderPassShader &) = delete;
116  HdStRenderPassShader &operator =(const HdStRenderPassShader &) = delete;
117 
118  HioGlslfx const * _GetGlslfx() const override;
119 };
120 
121 
123 
124 #endif // PXR_IMAGING_HD_ST_RENDER_PASS_SHADER_H
HDST_API std::string GetSource(TfToken const &shaderStageKey) const override
HDST_API void AddBufferBinding(HdBindingRequest const &req)
Add a custom binding request for use when this shader executes.
HDST_API ~HdStRenderPassShader() override
HDST_API HdStRenderPassShader()
GLbitfield GLuint program
Definition: glcorearb.h:1931
GLuint const GLchar * name
Definition: glcorearb.h:786
HDST_API void UnbindResources(int program, HdSt_ResourceBinder const &binder) override
Unbinds shader-specific resources.
HDST_API void BindResources(int program, HdSt_ResourceBinder const &binder) override
Definition: token.h:87
HDST_API void AddBindings(HdBindingRequestVector *customBindings) override
Add custom bindings (used by codegen)
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
HDST_API NamedTextureHandleVector const & GetNamedTextureHandles() const override
std::shared_ptr< class HdStRenderPassShader > HdStRenderPassShaderSharedPtr
HDST_API void ClearBufferBindings()
Clear all custom bindings associated with this shader.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
std::vector< NamedTextureHandle > NamedTextureHandleVector
Definition: shaderCode.h:160
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDST_API ID ComputeHash() const override
HdShader overrides.
HDST_API void RemoveBufferBinding(TfToken const &name)
Remove name from custom binding.
std::vector< HdRenderPassAovBinding > HdRenderPassAovBindingVector
Definition: aov.h:154
HDST_API void UpdateAovInputTextures(HdRenderPassAovBindingVector const &aovInputBindings, HdRenderIndex *const renderIndex)
HDST_API HdSt_MaterialParamVector const & GetParams() const override
Returns the shader parameters for this shader.
std::vector< class HdSt_MaterialParam > HdSt_MaterialParamVector
std::vector< class HdBindingRequest > HdBindingRequestVector
Definition: binding.h:41