HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
renderPass.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_RENDER_PASS_H
25 #define PXR_IMAGING_HD_RENDER_PASS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
32 #include "pxr/imaging/hd/task.h"
33 
34 #include <memory>
35 
37 
38 class HdRenderIndex;
39 class HdSceneDelegate;
40 
41 using HdDirtyListSharedPtr = std::shared_ptr<class HdDirtyList>;
42 using HdRenderPassSharedPtr = std::shared_ptr<class HdRenderPass>;
43 using HdRenderPassStateSharedPtr = std::shared_ptr<class HdRenderPassState>;
44 
45 /// \class HdRenderPass
46 ///
47 /// An abstract class representing a single render iteration over a set of prims
48 /// (the HdRprimCollection), for the camera/viewport parameters in
49 /// HdRenderPassState.
50 ///
51 /// Conceptually, a rendering task may be broken down into one or more
52 /// HdRenderPass(es).
53 ///
54 /// An HdRenderPass has two phases, Sync() and Execute(), in line with Hydra's
55 /// execution phases (See HdEngine::Execute)
56 ///
57 /// The base class implementation of Sync() takes care of syncing collection
58 /// changes with the HdRenderIndex via HdDirtyList, and allows derived classes
59 /// to track collection changes (via _MarkCollectionDirty) and sync additional
60 /// resources (via _Sync)
61 ///
62 /// Renderer backends implement _Execute, wherein the HdDrawItem(s) for the
63 /// collection may be consumed via HdRenderIndex::GetDrawItems.
64 /// Typically, the HdRenderPassState argument of _Execute is made available via
65 /// the HdTaskContext.
66 ///
67 /// \note
68 /// Rendering backends are expected to specialize this abstract class, and
69 /// return the specialized object via HdRenderDelegate::CreateRenderPass
70 ///
72 {
73 public:
74  HD_API
76  HD_API
77  virtual ~HdRenderPass();
78 
79  /// Returns the HdRprimCollection to be drawn by this RenderPass.
80  HdRprimCollection const& GetRprimCollection() const { return _collection; }
81 
82  /// Sets the HdRprimCollection, note that this may invalidate internal
83  /// caches used to accelerate drawing.
84  HD_API
85  void SetRprimCollection(HdRprimCollection const& col);
86 
87  /// Returns the dirty list (maintained in the change tracker) for
88  /// efficient traversal
90  return _dirtyList;
91  }
92 
93  /// Return the render index
94  HdRenderIndex* GetRenderIndex() const { return _renderIndex; }
95 
96  // ---------------------------------------------------------------------- //
97  /// \name Synchronization
98  // ---------------------------------------------------------------------- //
99 
100  /// Sync the render pass resources
101  HD_API
102  void Sync();
103 
104  // ---------------------------------------------------------------------- //
105  /// \name Prepare
106  // ---------------------------------------------------------------------- //
107 
108  /// Prepare renderpass data
109  HD_API
110  void Prepare(TfTokenVector const &renderTags);
111 
112  // ---------------------------------------------------------------------- //
113  /// \name Execution
114  // ---------------------------------------------------------------------- //
115 
116  /// Execute a subset of buckets of this renderpass.
117  HD_API
118  void Execute(HdRenderPassStateSharedPtr const &renderPassState,
119  TfTokenVector const &renderTags);
120 
121  // ---------------------------------------------------------------------- //
122  /// \name Optional API hooks for progressive rendering
123  // ---------------------------------------------------------------------- //
124 
125  virtual bool IsConverged() const { return true; }
126 
127 protected:
128  /// Virtual API: Execute the buckets corresponding to renderTags;
129  /// renderTags.empty() implies execute everything.
130  virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState,
131  TfTokenVector const &renderTags) = 0;
132 
133  /// Optional API: let derived classes mark their collection tracking as dirty.
134  virtual void _MarkCollectionDirty() {}
135 
136  /// Optional API: let derived classes sync data.
137  virtual void _Sync() {}
138 
139  /// Optional API: let derived classes prepare data.
140  virtual void _Prepare(TfTokenVector const &renderTags) {}
141 
142 private:
143 
144  // Don't allow copies
145  HdRenderPass(const HdRenderPass &) = delete;
146  HdRenderPass &operator=(const HdRenderPass &) = delete;
147 
148  // ---------------------------------------------------------------------- //
149  // \name Change Tracking State
150  // ---------------------------------------------------------------------- //
151  // The renderIndex to which this renderPass belongs
152  // (can't change after construction)
153  HdRenderIndex * const _renderIndex;
154 
155  // cached dirty prims list
156  HdDirtyListSharedPtr _dirtyList;
157 
158  // ---------------------------------------------------------------------- //
159  // \name Core RenderPass State
160  // ---------------------------------------------------------------------- //
161  HdRprimCollection _collection;
162 };
163 
165 
166 #endif //PXR_IMAGING_HD_RENDER_PASS_H
HdRenderIndex * GetRenderIndex() const
Return the render index.
Definition: renderPass.h:94
std::shared_ptr< class HdRenderPassState > HdRenderPassStateSharedPtr
Definition: engine.h:42
HD_API void Execute(HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags)
Execute a subset of buckets of this renderpass.
std::shared_ptr< class HdRenderPass > HdRenderPassSharedPtr
Definition: engine.h:41
virtual void _Sync()
Optional API: let derived classes sync data.
Definition: renderPass.h:137
#define HD_API
Definition: api.h:40
virtual void _MarkCollectionDirty()
Optional API: let derived classes mark their collection tracking as dirty.
Definition: renderPass.h:134
HD_API HdRenderPass(HdRenderIndex *index, HdRprimCollection const &collection)
virtual HD_API ~HdRenderPass()
HdRprimCollection const & GetRprimCollection() const
Returns the HdRprimCollection to be drawn by this RenderPass.
Definition: renderPass.h:80
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
HD_API void Sync()
Sync the render pass resources.
HD_API void Prepare(TfTokenVector const &renderTags)
Prepare renderpass data.
HdDirtyListSharedPtr const & GetDirtyList() const
Definition: renderPass.h:89
HD_API void SetRprimCollection(HdRprimCollection const &col)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
GLuint index
Definition: glcorearb.h:785
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual bool IsConverged() const
Definition: renderPass.h:125
virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags)=0
std::shared_ptr< class HdDirtyList > HdDirtyListSharedPtr
Definition: dirtyList.h:39
virtual void _Prepare(TfTokenVector const &renderTags)
Optional API: let derived classes prepare data.
Definition: renderPass.h:140