HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
strategyBase.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_STRATEGY_BASE_H
25 #define PXR_IMAGING_HD_STRATEGY_BASE_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hd/api.h"
29 #include "pxr/imaging/hd/version.h"
32 
33 #include "pxr/base/tf/token.h"
34 #include "pxr/base/vt/dictionary.h"
35 
36 #include <memory>
37 
39 
40 
41 using HdBufferArraySharedPtr = std::shared_ptr<class HdBufferArray>;
42 using HdBufferArrayRangeSharedPtr = std::shared_ptr<class HdBufferArrayRange>;
43 
44 /// \class HdAggregationStrategy
45 ///
46 /// Aggregation strategy base class.
47 ///
49 public:
50  /// Aggregation ID
51  typedef size_t AggregationId;
52 
53  HD_API
54  virtual ~HdAggregationStrategy();
55 
56  /// Factory for creating HdBufferArray
58  TfToken const &role,
59  HdBufferSpecVector const &bufferSpecs,
60  HdBufferArrayUsageHint usageHint) = 0;
61 
62  /// Factory for creating HdBufferArrayRange
64 
65 
66  /// Returns id for given bufferSpecs to be used for aggregation
68  HdBufferSpecVector const &bufferSpecs,
69  HdBufferArrayUsageHint usageHint) const = 0;
70 
71  /// Returns the buffer specs from a given buffer array
73  HdBufferArraySharedPtr const &bufferArray) const = 0;
74 
75  /// Returns the accumulated GPU resource allocation 
 /// for items in the BufferArray passed as parameter
76  virtual size_t GetResourceAllocation(
77  HdBufferArraySharedPtr const &bufferArray,
78  VtDictionary &result) const = 0;
79 
80  /// (Optional) called to Flush consolidated / staging buffers.
81  HD_API
82  virtual void Flush() {}
83 };
84 
85 
87 
88 #endif // PXR_IMAGING_HD_STRATEGY_BASE_H
std::shared_ptr< class HdBufferArray > HdBufferArraySharedPtr
Definition: bufferArray.h:44
virtual HdBufferArrayRangeSharedPtr CreateBufferArrayRange()=0
Factory for creating HdBufferArrayRange.
virtual HD_API ~HdAggregationStrategy()
virtual HdBufferSpecVector GetBufferSpecs(HdBufferArraySharedPtr const &bufferArray) const =0
Returns the buffer specs from a given buffer array.
size_t AggregationId
Aggregation ID.
Definition: strategyBase.h:51
#define HD_API
Definition: api.h:40
virtual AggregationId ComputeAggregationId(HdBufferSpecVector const &bufferSpecs, HdBufferArrayUsageHint usageHint) const =0
Returns id for given bufferSpecs to be used for aggregation.
Definition: token.h:87
GLuint64EXT * result
Definition: glew.h:14311
virtual size_t GetResourceAllocation(HdBufferArraySharedPtr const &bufferArray, VtDictionary &result) const =0
Returns the accumulated GPU resource allocation 
 /// for items in the BufferArray passed as paramete...
std::vector< struct HdBufferSpec > HdBufferSpecVector
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::shared_ptr< HdBufferArrayRange > HdBufferArrayRangeSharedPtr
Definition: bufferArray.h:45
virtual HdBufferArraySharedPtr CreateBufferArray(TfToken const &role, HdBufferSpecVector const &bufferSpecs, HdBufferArrayUsageHint usageHint)=0
Factory for creating HdBufferArray.
virtual HD_API void Flush()
(Optional) called to Flush consolidated / staging buffers.
Definition: strategyBase.h:82