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_ST_RENDER_PASS_H
25 #define PXR_IMAGING_HD_ST_RENDER_PASS_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
31 
32 #include <unordered_map>
33 
35 
36 class Hgi;
37 
38 /// \class HdSt_RenderPass
39 ///
40 /// A single draw pass to a render target/buffer. Stream implementation.
41 ///
42 class HdSt_RenderPass : public HdRenderPass {
43 public:
44  HDST_API
46  HDST_API
47  virtual ~HdSt_RenderPass();
48 
49  /// Returns the number of draw items used by this render pass.
50  /// Will only return the correct value after Prepare() has been called on
51  /// HdRenderPass. Calling this during Sync() will return last frame's
52  /// drawItem count.
53  HDST_API
54  size_t GetDrawItemCount() const;
55 
56 protected:
57  virtual void _Prepare(TfTokenVector const &renderTags) override;
58 
59  /// Execute the buckets corresponding to renderTags
60  virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState,
61  TfTokenVector const &renderTags) override;
62 
63  virtual void _MarkCollectionDirty() override;
64 
65 private:
66  void _PrepareDrawItems(TfTokenVector const& renderTags);
67  void _PrepareCommandBuffer(TfTokenVector const& renderTags);
68 
69  // XXX: This should really be in HdSt_DrawBatch::PrepareDraw.
70  void _FrustumCullCPU(HdStRenderPassStateSharedPtr const &renderPassState);
71 
72  // -----------------------------------------------------------------------
73  // Drawing state
74  HdStCommandBuffer _cmdBuffer;
75 
76  int _lastSettingsVersion;
77  bool _useTinyPrimCulling;
78 
79  // -----------------------------------------------------------------------
80  // Change tracking state.
81 
82  // The version number of the currently held collection.
83  int _collectionVersion;
84 
85  // The version number of the currently active render tags
86  int _renderTagVersion;
87 
88  // The version number of the material tags (of the rprims).
89  unsigned int _materialTagsVersion;
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.
101  size_t _drawItemCount;
102  bool _drawItemsChanged;
103 
104  Hgi* _hgi;
105 };
106 
108 
109 #endif // PXR_IMAGING_HD_ST_RENDER_PASS_H
std::shared_ptr< class HdRenderPassState > HdRenderPassStateSharedPtr
Definition: engine.h:42
std::vector< HdDrawItem const * > HdDrawItemPtrVector
Definition: renderIndex.h:119
virtual void _MarkCollectionDirty() override
Optional API: let derived classes mark their collection tracking as dirty.
std::shared_ptr< class HdStRenderPassState > HdStRenderPassStateSharedPtr
Definition: commandBuffer.h:45
virtual HDST_API ~HdSt_RenderPass()
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
virtual void _Execute(HdRenderPassStateSharedPtr const &renderPassState, TfTokenVector const &renderTags) override
Execute the buckets corresponding to renderTags.
Definition: hgi.h:106
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define HDST_API
Definition: api.h:40
GLuint index
Definition: glcorearb.h:785
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual void _Prepare(TfTokenVector const &renderTags) override
Optional API: let derived classes prepare data.
HDST_API size_t GetDrawItemCount() const
HDST_API HdSt_RenderPass(HdRenderIndex *index, HdRprimCollection const &collection)