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 HDST_RENDER_PASS_H
25 #define HDST_RENDER_PASS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hdSt/commandBuffer.h"
30 #include "pxr/imaging/hd/renderPass.h"
31 
32 #include <boost/shared_ptr.hpp>
33 #include <unordered_map>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 typedef boost::shared_ptr<class HdSt_RenderPass> HdSt_RenderPassSharedPtr;
38 
39 class Hgi;
40 
45 class HdSt_RenderPass : public HdRenderPass {
46 public:
47  HDST_API
48  HdSt_RenderPass(HdRenderIndex *index, HdRprimCollection const &collection);
49  HDST_API
50  virtual ~HdSt_RenderPass();
51 
56  HDST_API
57  size_t GetDrawItemCount() const;
58 
59 protected:
60  virtual void _Prepare(TfTokenVector const &renderTags) override;
61 
63  virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState,
64  TfTokenVector const &renderTags) override;
65 
66  virtual void _MarkCollectionDirty() override;
67 
68 private:
69  void _PrepareDrawItems(TfTokenVector const& renderTags);
70  void _PrepareCommandBuffer(TfTokenVector const& renderTags);
71 
72  // XXX: This should really be in HdSt_DrawBatch::PrepareDraw.
73  void _Cull(HdStRenderPassStateSharedPtr const &renderPasssState);
74 
75  // -----------------------------------------------------------------------
76  // Drawing state
77  HdStCommandBuffer _cmdBuffer;
78 
79  int _lastSettingsVersion;
80  bool _useTinyPrimCulling;
81 
82  // -----------------------------------------------------------------------
83  // Change tracking state.
84 
85  // The version number of the currently held collection.
86  int _collectionVersion;
87 
88  // The version number of the currently active render tags
89  int _renderTagVersion;
90 
91  // A flag indicating that the held collection changed since this renderPass
92  // was last drawn.
93  //
94  // When _collectionChanged is true, it indicates that _collectionVersion is
95  // no longer accurate, because _collectionVersion was stored for the
96  // previously held collection.
97  bool _collectionChanged;
98 
99  // DrawItems that are used to build the draw batches.
100  HdRenderIndex::HdDrawItemPtrVector _drawItems;
101  size_t _drawItemCount;
102  bool _drawItemsChanged;
103 
104  Hgi* _hgi;
105 };
106 
107 PXR_NAMESPACE_CLOSE_SCOPE
108 
109 #endif // HDST_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
A buffer of commands (HdStDrawItem or HdComputeItem objects) to be executed.
Definition: commandBuffer.h:60
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...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A named, semantic collection of objects.
Hydra Graphics Interface.
Definition: hgi.h:56