All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderPass.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 HD_RENDER_PASS_H
25 #define HD_RENDER_PASS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
30 #include "pxr/imaging/hd/changeTracker.h"
31 #include "pxr/imaging/hd/rprimCollection.h"
32 #include "pxr/imaging/hd/task.h"
33 
34 #include <boost/shared_ptr.hpp>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
38 class HdRenderIndex;
39 class HdSceneDelegate;
40 
41 typedef boost::shared_ptr<class HdDirtyList> HdDirtyListSharedPtr;
42 typedef boost::shared_ptr<class HdRenderPassState> HdRenderPassStateSharedPtr;
43 typedef boost::shared_ptr<class HdRenderPass> HdRenderPassSharedPtr;
44 
71 class HdRenderPass : boost::noncopyable {
72 public:
73  HD_API
74  HdRenderPass(HdRenderIndex *index, HdRprimCollection const& collection);
75  HD_API
76  virtual ~HdRenderPass();
77 
79  HdRprimCollection const& GetRprimCollection() const { return _collection; }
80 
83  HD_API
84  void SetRprimCollection(HdRprimCollection const& col);
85 
88  HdDirtyListSharedPtr const &GetDirtyList() const {
89  return _dirtyList;
90  }
91 
93  HdRenderIndex* GetRenderIndex() const { return _renderIndex; }
94 
95  // ---------------------------------------------------------------------- //
97  // ---------------------------------------------------------------------- //
98 
100  HD_API
101  void Sync();
102 
103  // ---------------------------------------------------------------------- //
105  // ---------------------------------------------------------------------- //
106 
108  HD_API
109  void Prepare(TfTokenVector const &renderTags);
110 
111  // ---------------------------------------------------------------------- //
113  // ---------------------------------------------------------------------- //
114 
116  HD_API
117  void Execute(HdRenderPassStateSharedPtr const &renderPassState,
118  TfTokenVector const &renderTags);
119 
120  // ---------------------------------------------------------------------- //
122  // ---------------------------------------------------------------------- //
123 
124  virtual bool IsConverged() const { return true; }
125 
126 protected:
129  virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState,
130  TfTokenVector const &renderTags) = 0;
131 
133  virtual void _MarkCollectionDirty() {}
134 
136  virtual void _Sync() {}
137 
139  virtual void _Prepare(TfTokenVector const &renderTags) {}
140 
141 private:
142  // ---------------------------------------------------------------------- //
143  // \name Change Tracking State
144  // ---------------------------------------------------------------------- //
145  // The renderIndex to which this renderPass belongs
146  // (can't change after construction)
147  HdRenderIndex * const _renderIndex;
148 
149  // cached dirty prims list
150  HdDirtyListSharedPtr _dirtyList;
151 
152  // ---------------------------------------------------------------------- //
153  // \name Core RenderPass State
154  // ---------------------------------------------------------------------- //
155  HdRprimCollection _collection;
156 };
157 
158 PXR_NAMESPACE_CLOSE_SCOPE
159 
160 #endif //HD_RENDER_PASS_H
virtual void _MarkCollectionDirty()
Optional API: let derived classes mark their collection tracking as dirty.
Definition: renderPass.h:133
The Hydra render index is a flattened representation of the client scene graph, which may be composed...
Definition: renderIndex.h:119
HD_API void Execute(HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags)
Execute a subset of buckets of this renderpass.
HdDirtyListSharedPtr const & GetDirtyList() const
Returns the dirty list (maintained in the change tracker) for efficient traversal.
Definition: renderPass.h:88
HdRprimCollection const & GetRprimCollection() const
Returns the HdRprimCollection to be drawn by this RenderPass.
Definition: renderPass.h:79
HD_API void SetRprimCollection(HdRprimCollection const &col)
Sets the HdRprimCollection, note that this may invalidate internal caches used to accelerate drawing...
virtual void _Prepare(TfTokenVector const &renderTags)
Optional API: let derived classes prepare data.
Definition: renderPass.h:139
An abstract class representing a single render iteration over a set of prims (the HdRprimCollection)...
Definition: renderPass.h:71
virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags)=0
Virtual API: Execute the buckets corresponding to renderTags; renderTags.empty() implies execute ever...
Adapter class providing data exchange with the client scene graph.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
HdRenderIndex * GetRenderIndex() const
Return the render index.
Definition: renderPass.h:93
A named, semantic collection of objects.
virtual void _Sync()
Optional API: let derived classes sync data.
Definition: renderPass.h:136
HD_API void Sync()
Sync the render pass resources.
HD_API void Prepare(TfTokenVector const &renderTags)
Prepare renderpass data.