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 
44 /// \class HdStRenderPassShader
45 ///
46 /// A shader that supports common renderPass functionality.
47 ///
49 public:
50  HDST_API
52  HDST_API
53  HdStRenderPassShader(TfToken const &glslfxFile);
54  HDST_API
55  virtual ~HdStRenderPassShader() override;
56 
57  /// HdShader overrides
58  HDST_API
59  virtual ID ComputeHash() const override;
60  HDST_API
61  virtual std::string GetSource(TfToken const &shaderStageKey) const override;
62  HDST_API
63  virtual void BindResources(int program,
64  HdSt_ResourceBinder const &binder,
65  HdRenderPassState const &state) override;
66  HDST_API
67  virtual void UnbindResources(int program,
68  HdSt_ResourceBinder const &binder,
69  HdRenderPassState const &state) override;
70  HDST_API
71  virtual void AddBindings(HdBindingRequestVector *customBindings) override;
72  HDST_API
73  virtual HdSt_MaterialParamVector const& GetParams() const override;
74 
75  /// Add a custom binding request for use when this shader executes.
76  HDST_API
77  void AddBufferBinding(HdBindingRequest const& req);
78 
79  /// Remove \p name from custom binding.
80  HDST_API
81  void RemoveBufferBinding(TfToken const &name);
82 
83  /// Clear all custom bindings associated with this shader.
84  HDST_API
85  void ClearBufferBindings();
86 
87  /// Add a request to read an AOV back in the shader. The shader can
88  /// access the requested AOV as HdGet_NAMEReadback().
89  HDST_API
90  void AddAovReadback(TfToken const &name);
91 
92  /// Remove \p name from requests to read AOVs.
93  HDST_API
94  void RemoveAovReadback(TfToken const &name);
95 
97  return _cullStyle;
98  }
99 
100  void SetCullStyle(HdCullStyle cullStyle) {
101  _cullStyle = cullStyle;
102  }
103 
104 private:
105  TfToken _glslfxFile;
106  std::unique_ptr<HioGlslfx> _glslfx;
107  mutable size_t _hash;
108  mutable bool _hashValid;
109 
111  HdCullStyle _cullStyle;
112 
113  TfHashSet<TfToken, TfToken::HashFunctor> _aovReadbackRequests;
114  HdSt_MaterialParamVector _params;
115 
116  // No copying
117  HdStRenderPassShader(const HdStRenderPassShader &) = delete;
118  HdStRenderPassShader &operator =(const HdStRenderPassShader &) = delete;
119 };
120 
121 
123 
124 #endif // PXR_IMAGING_HD_ST_RENDER_PASS_SHADER_H
HdCullStyle
Definition: enums.h:122
HDST_API void AddBufferBinding(HdBindingRequest const &req)
Add a custom binding request for use when this shader executes.
GLuint const GLchar * name
Definition: glew.h:1814
virtual HDST_API void UnbindResources(int program, HdSt_ResourceBinder const &binder, HdRenderPassState const &state) override
Unbinds shader-specific resources.
HDST_API void RemoveAovReadback(TfToken const &name)
Remove name from requests to read AOVs.
HDST_API HdStRenderPassShader()
Definition: token.h:87
virtual HDST_API ID ComputeHash() const override
HdShader overrides.
virtual HDST_API std::string GetSource(TfToken const &shaderStageKey) const override
void SetCullStyle(HdCullStyle cullStyle)
HdCullStyle GetCullStyle() const
virtual HDST_API ~HdStRenderPassShader() override
std::shared_ptr< class HdStRenderPassShader > HdStRenderPassShaderSharedPtr
GLsizei const GLchar *const * string
Definition: glew.h:1844
HDST_API void ClearBufferBindings()
Clear all custom bindings associated with this shader.
virtual HDST_API HdSt_MaterialParamVector const & GetParams() const override
Returns the shader parameters for this shader.
virtual HDST_API void BindResources(int program, HdSt_ResourceBinder const &binder, HdRenderPassState const &state) override
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
HDST_API void AddAovReadback(TfToken const &name)
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual HDST_API void AddBindings(HdBindingRequestVector *customBindings) override
Add custom bindings (used by codegen)
GLuint program
Definition: glew.h:5881
HDST_API void RemoveBufferBinding(TfToken const &name)
Remove name from custom binding.
std::vector< class HdSt_MaterialParam > HdSt_MaterialParamVector
std::vector< class HdBindingRequest > HdBindingRequestVector
Definition: binding.h:39