All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderPassShader.h
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"
31 #include "pxr/imaging/hdSt/resourceBinder.h"
32 #include "pxr/imaging/hdSt/shaderCode.h"
33 #include "pxr/imaging/hio/glslfx.h"
34 
35 #include "pxr/base/tf/declarePtrs.h"
36 #include "pxr/base/tf/token.h"
37 
38 #include <boost/shared_ptr.hpp>
39 
40 PXR_NAMESPACE_OPEN_SCOPE
41 
42 
43 typedef boost::shared_ptr<class HdStRenderPassShader> HdStRenderPassShaderSharedPtr;
44 
50 public:
51  HDST_API
53  HDST_API
54  HdStRenderPassShader(TfToken const &glslfxFile);
55  HDST_API
56  virtual ~HdStRenderPassShader() override;
57 
59  HDST_API
60  virtual ID ComputeHash() const override;
61  HDST_API
62  virtual std::string GetSource(TfToken const &shaderStageKey) const override;
63  HDST_API
64  virtual void BindResources(int program,
65  HdSt_ResourceBinder const &binder,
66  HdRenderPassState const &state) override;
67  HDST_API
68  virtual void UnbindResources(int program,
69  HdSt_ResourceBinder const &binder,
70  HdRenderPassState const &state) override;
71  HDST_API
72  virtual void AddBindings(HdBindingRequestVector *customBindings) override;
73  HDST_API
74  virtual HdMaterialParamVector const& GetParams() const override;
75 
77  HDST_API
78  void AddBufferBinding(HdBindingRequest const& req);
79 
81  HDST_API
82  void RemoveBufferBinding(TfToken const &name);
83 
85  HDST_API
86  void ClearBufferBindings();
87 
90  HDST_API
91  void AddAovReadback(TfToken const &name);
92 
94  HDST_API
95  void RemoveAovReadback(TfToken const &name);
96 
97  HdCullStyle GetCullStyle() const {
98  return _cullStyle;
99  }
100 
101  void SetCullStyle(HdCullStyle cullStyle) {
102  _cullStyle = cullStyle;
103  }
104 
105 private:
106  TfToken _glslfxFile;
107  boost::scoped_ptr<HioGlslfx> _glslfx;
108  mutable size_t _hash;
109  mutable bool _hashValid;
110 
111  TfHashMap<TfToken, HdBindingRequest, TfToken::HashFunctor> _customBuffers;
112  HdCullStyle _cullStyle;
113 
114  TfHashSet<TfToken, TfToken::HashFunctor> _aovReadbackRequests;
115  HdMaterialParamVector _params;
116 
117  // No copying
118  HdStRenderPassShader(const HdStRenderPassShader &) = delete;
119  HdStRenderPassShader &operator =(const HdStRenderPassShader &) = delete;
120 };
121 
122 
123 PXR_NAMESPACE_CLOSE_SCOPE
124 
125 #endif // PXR_IMAGING_HD_ST_RENDER_PASS_SHADER_H
virtual HDST_API void AddBindings(HdBindingRequestVector *customBindings) override
Add custom bindings (used by codegen)
virtual HDST_API ID ComputeHash() const override
HdShader overrides.
HDST_API void RemoveBufferBinding(TfToken const &name)
Remove name from custom binding.
A set of rendering parameters used among render passes.
virtual HDST_API std::string GetSource(TfToken const &shaderStageKey) const override
Returns the shader source provided by this shader for shaderStageKey.
virtual HDST_API void UnbindResources(int program, HdSt_ResourceBinder const &binder, HdRenderPassState const &state) override
Unbinds shader-specific resources.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
HDST_API void ClearBufferBindings()
Clear all custom bindings associated with this shader.
HDST_API void AddAovReadback(TfToken const &name)
Add a request to read an AOV back in the shader.
A base class representing the implementation (code) of a shader, used in conjunction with HdRenderPas...
Definition: shaderCode.h:61
A shader that supports common renderPass functionality.
virtual HDST_API HdMaterialParamVector const & GetParams() const override
Returns the shader parameters for this shader.
HDST_API void RemoveAovReadback(TfToken const &name)
Remove name from requests to read AOVs.
virtual HDST_API void BindResources(int program, HdSt_ResourceBinder const &binder, HdRenderPassState const &state) override
Binds shader-specific resources to program XXX: this interface is meant to be used for bridging the G...
BindingRequest allows externally allocated buffers to be bound at render time.
Definition: binding.h:116
HDST_API void AddBufferBinding(HdBindingRequest const &req)
Add a custom binding request for use when this shader executes.