HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
commandBuffer.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_COMMAND_BUFFER_H
25 #define PXR_IMAGING_HD_ST_COMMAND_BUFFER_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/imaging/hd/version.h"
31 
32 #include "pxr/base/gf/matrix4d.h"
33 
34 #include <memory>
35 #include <vector>
36 
38 
39 class HdRenderIndex;
40 class HdStDrawItem;
42 class HgiCapabilities;
43 class HgiGraphicsCmds;
44 
45 using HdStRenderPassStateSharedPtr = std::shared_ptr<class HdStRenderPassState>;
47  std::shared_ptr<class HdStResourceRegistry>;
48 
49 using HdDrawItemConstPtrVector = std::vector<class HdDrawItem const*>;
51  = std::shared_ptr<HdDrawItemConstPtrVector>;
52 
53 using HdSt_DrawBatchSharedPtr = std::shared_ptr<class HdSt_DrawBatch>;
54 using HdSt_DrawBatchSharedPtrVector = std::vector<HdSt_DrawBatchSharedPtr>;
55 
56 /// \class HdStCommandBuffer
57 ///
58 /// A buffer of commands (HdStDrawItem or HdComputeItem objects) to be executed.
59 ///
60 /// The HdStCommandBuffer is responsible for accumulating draw items and sorting
61 /// them for correctness (e.g. alpha transparency) and efficiency (e.g. the
62 /// fewest number of GPU state changes).
63 ///
65 public:
66  HDST_API
68  HDST_API
70 
71  /// Prepare the command buffer for draw
72  HDST_API
73  void PrepareDraw(HgiGraphicsCmds *gfxCmds,
74  HdStRenderPassStateSharedPtr const &renderPassState,
75  HdRenderIndex *renderIndex);
76 
77  /// Execute the command buffer
78  HDST_API
79  void ExecuteDraw(HgiGraphicsCmds *gfxCmds,
80  HdStRenderPassStateSharedPtr const &renderPassState,
81  HdStResourceRegistrySharedPtr const &resourceRegistry);
82 
83  /// Sync visibility state from RprimSharedState to DrawItemInstances.
84  HDST_API
85  void SyncDrawItemVisibility(unsigned visChangeCount);
86 
87  /// Sets the draw items to use for batching.
88  /// If the shared pointer or version is different, batches are rebuilt and
89  /// the batch version is updated.
90  HDST_API
91  void SetDrawItems(HdDrawItemConstPtrVectorSharedPtr const &drawItems,
92  unsigned currentBatchVersion,
93  HgiCapabilities const *hgiCapabilities);
94 
95  /// Rebuild all draw batches if any underlying buffer array is invalidated.
96  HDST_API
97  void RebuildDrawBatchesIfNeeded(unsigned currentBatchVersion,
98  HgiCapabilities const *hgiCapabilities);
99 
100  /// Returns the total number of draw items, including culled items.
101  size_t GetTotalSize() const {
102  if (_drawItems) return _drawItems->size();
103  return 0;
104  }
105 
106  /// Returns the number of draw items, excluding culled items.
107  size_t GetVisibleSize() const { return _visibleSize; }
108 
109  /// Returns the number of culled draw items.
110  size_t GetCulledSize() const {
111  if (_drawItems) {
112  return _drawItems->size() - _visibleSize;
113  }
114  return 0;
115  }
116 
117  HDST_API
118  void SetEnableTinyPrimCulling(bool tinyPrimCulling);
119 
120 private:
121  void _RebuildDrawBatches(HgiCapabilities const *hgiCapabilities);
122 
123  /// Cull drawItemInstances based on view frustum cull matrix
124  void _FrustumCullCPU(GfMatrix4d const &cullMatrix);
125 
127  std::vector<HdStDrawItemInstance> _drawItemInstances;
128  HdSt_DrawBatchSharedPtrVector _drawBatches;
129  size_t _visibleSize;
130  unsigned int _visChangeCount;
131  unsigned int _drawBatchesVersion;
132 };
133 
134 
136 
137 #endif //PXR_IMAGING_HD_ST_COMMAND_BUFFER_H
std::shared_ptr< class HdStRenderPassState > HdStRenderPassStateSharedPtr
Definition: commandBuffer.h:45
std::shared_ptr< HdDrawItemConstPtrVector > HdDrawItemConstPtrVectorSharedPtr
Definition: commandBuffer.h:51
HDST_API HdStCommandBuffer()
HDST_API void SyncDrawItemVisibility(unsigned visChangeCount)
Sync visibility state from RprimSharedState to DrawItemInstances.
size_t GetTotalSize() const
Returns the total number of draw items, including culled items.
size_t GetVisibleSize() const
Returns the number of draw items, excluding culled items.
HDST_API void SetEnableTinyPrimCulling(bool tinyPrimCulling)
HDST_API void ExecuteDraw(HgiGraphicsCmds *gfxCmds, HdStRenderPassStateSharedPtr const &renderPassState, HdStResourceRegistrySharedPtr const &resourceRegistry)
Execute the command buffer.
HDST_API void RebuildDrawBatchesIfNeeded(unsigned currentBatchVersion, HgiCapabilities const *hgiCapabilities)
Rebuild all draw batches if any underlying buffer array is invalidated.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
size_t GetCulledSize() const
Returns the number of culled draw items.
std::vector< HdSt_DrawBatchSharedPtr > HdSt_DrawBatchSharedPtrVector
Definition: commandBuffer.h:54
HDST_API ~HdStCommandBuffer()
#define HDST_API
Definition: api.h:40
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HDST_API void PrepareDraw(HgiGraphicsCmds *gfxCmds, HdStRenderPassStateSharedPtr const &renderPassState, HdRenderIndex *renderIndex)
Prepare the command buffer for draw.
std::vector< class HdDrawItem const * > HdDrawItemConstPtrVector
Definition: commandBuffer.h:49
HDST_API void SetDrawItems(HdDrawItemConstPtrVectorSharedPtr const &drawItems, unsigned currentBatchVersion, HgiCapabilities const *hgiCapabilities)
std::shared_ptr< class HdStResourceRegistry > HdStResourceRegistrySharedPtr
Definition: commandBuffer.h:47
std::shared_ptr< class HdSt_DrawBatch > HdSt_DrawBatchSharedPtr
Definition: commandBuffer.h:53