24#ifndef PXR_IMAGING_HD_ST_VBO_MEMORY_MANAGER_H
25#define PXR_IMAGING_HD_ST_VBO_MEMORY_MANAGER_H
28#include "pxr/imaging/hdSt/api.h"
29#include "pxr/imaging/hdSt/strategyBase.h"
31#include "pxr/imaging/hgi/enums.h"
33#include "pxr/imaging/hd/bufferArray.h"
34#include "pxr/imaging/hdSt/bufferArrayRange.h"
35#include "pxr/imaging/hd/bufferSpec.h"
36#include "pxr/imaging/hd/bufferSource.h"
44PXR_NAMESPACE_OPEN_SCOPE
57 , _resourceRegistry(resourceRegistry) {}
64 HdBufferSpecVector
const &bufferSpecs,
65 HdBufferArrayUsageHint usageHint);
75 HdBufferSpecVector
const &bufferSpecs,
76 HdBufferArrayUsageHint usageHint)
const;
80 HdBufferArraySharedPtr
const &bufferArray)
const;
84 HdBufferArraySharedPtr
const &bufferArray,
97 _stripedBufferArray(nullptr),
110 return (
bool)_stripedBufferArray;
130 void CopyData(HdBufferSourceSharedPtr
const &bufferSource)
override;
138 return _elementOffset;
191 _elementOffset = offset;
196 _numElements = numElements;
206 _capacity = capacity;
211 _stripedBufferArray = NULL;
221 size_t _GetByteOffset(HdStBufferResourceSharedPtr
const& resource)
233 using _StripedBufferArraySharedPtr =
234 std::shared_ptr<_StripedBufferArray>;
235 using _StripedBufferArrayRangeSharedPtr =
236 std::shared_ptr<_StripedBufferArrayRange>;
237 using _StripedBufferArrayRangePtr =
238 std::weak_ptr<_StripedBufferArrayRange>;
248 HdBufferSpecVector
const &bufferSpecs,
249 HdBufferArrayUsageHint usageHint);
268 std::vector<HdBufferArrayRangeSharedPtr>
const &ranges,
269 HdBufferArraySharedPtr
const &curRangeOwner)
override;
282 _needsCompaction =
true;
299 {
return _resourceList;}
307 void _DeallocateResources();
319 bool _needsCompaction;
321 size_t _maxBytesPerElement;
322 HgiBufferUsage _bufferUsage;
324 HdStBufferResourceNamedList _resourceList;
327 _StripedBufferArrayRangeSharedPtr _GetRangeSharedPtr(
size_t idx)
const {
328 return std::static_pointer_cast<_StripedBufferArrayRange>(
GetRange(idx).lock());
335PXR_NAMESPACE_CLOSE_SCOPE
Similar to a VAO, this object is a bundle of coherent buffers.
bool _needsReallocation
Dirty bit to set when the ranges attached to the buffer changes.
HD_API void IncrementVersion()
Increments the version of this buffer array.
HD_API HdBufferArrayRangePtr GetRange(size_t idx) const
Get the attached range at the specified index.
size_t GetVersion() const
Returns the version of this buffer array.
Aggregation strategy base class.
size_t AggregationId
Aggregation ID.
Interface class for representing range (subset) locator of HdBufferArray.
A central registry of all GPU resources.
void SetNeedsCompaction()
Mark to perform compaction on GarbageCollect()
HDST_API ~_StripedBufferArray() override
Destructor. It invalidates _rangeList.
HDST_API HdStBufferResourceSharedPtr _AddResource(TfToken const &name, HdTupleType tupleType, int offset, int stride)
Adds a new, named GPU resource and returns it.
HDST_API HdStBufferResourceSharedPtr GetResource(TfToken const &name)
Returns the named GPU resource.
void SetNeedsReallocation()
Mark to perform reallocation on Reallocate()
HDST_API HdStBufferResourceSharedPtr GetResource() const
Returns the GPU resource.
HDST_API void Reallocate(std::vector< HdBufferArrayRangeSharedPtr > const &ranges, HdBufferArraySharedPtr const &curRangeOwner) override
Performs reallocation.
HDST_API bool GarbageCollect() override
perform compaction if necessary.
HDST_API void DebugDump(std::ostream &out) const override
Debug output.
HdStBufferResourceNamedList const & GetResources() const
Returns the list of all named GPU resources for this bufferArray.
HDST_API _StripedBufferArray(HdStResourceRegistry *resourceRegistry, TfToken const &role, HdBufferSpecVector const &bufferSpecs, HdBufferArrayUsageHint usageHint)
Constructor.
HDST_API size_t GetMaxNumElements() const override
Returns the maximum number of elements capacity.
HDST_API HdBufferSpecVector GetBufferSpecs() const
Reconstructs the bufferspecs and returns it (for buffer splitting)
specialized buffer array range
HDST_API void CopyData(HdBufferSourceSharedPtr const &bufferSource) override
Copy source data into buffer.
size_t GetNumElements() const override
Returns the number of elements.
HDST_API HdBufferArrayUsageHint GetUsageHint() const override
Returns the usage hint from the underlying buffer array.
HDST_API void SetBufferArray(HdBufferArray *bufferArray) override
Sets the buffer array associated with this buffer;.
int GetCapacity() const
Returns the capacity of allocated area.
void SetNumElements(int numElements)
Set the number of elements for this range.
void IncrementVersion() override
Increment the version of the buffer array.
bool IsValid() const override
Returns true if this range is valid.
_StripedBufferArrayRange(HdStResourceRegistry *resourceRegistry)
Constructor.
HDST_API bool IsAssigned() const override
Returns true is the range has been assigned to a buffer.
int GetElementOffset() const override
Returns the relative element offset in aggregated buffer.
HDST_API void DebugDump(std::ostream &out) const override
Debug dump.
bool IsImmutable() const override
Returns true if this bar is marked as immutable.
HDST_API ~_StripedBufferArrayRange() override
Destructor.
HDST_API size_t GetMaxNumElements() const override
Returns the max number of elements.
HDST_API HdStBufferResourceNamedList const & GetResources() const override
Returns the list of all named GPU resources for this bufferArrayRange.
void SetElementOffset(int offset)
Set the relative offset for this range.
size_t GetVersion() const override
Returns the version of the buffer array.
void Invalidate()
Make this range invalid.
bool RequiresStaging() const override
Returns true if this needs a staging buffer for CPU to GPU copies.
HDST_API HdStBufferResourceSharedPtr GetResource(TfToken const &name) override
Returns the named GPU resource.
HDST_API HdStBufferResourceSharedPtr GetResource() const override
Returns the GPU resource.
HDST_API VtValue ReadData(TfToken const &name) const override
Read back the buffer content.
void SetCapacity(int capacity)
Set the capacity of allocated area for this range.
HDST_API const void * _GetAggregation() const override
Returns the aggregation container.
HDST_API bool Resize(int numElements) override
Resize memory area for this range.
int GetByteOffset(TfToken const &resourceName) const override
Returns the byte offset at which this range begins in the underlying buffer array for the given resou...
virtual size_t GetResourceAllocation(HdBufferArraySharedPtr const &bufferArray, VtDictionary &result) const
Returns the size of the GPU memory used by the passed buffer array.
virtual HDST_API HdBufferArraySharedPtr CreateBufferArray(TfToken const &role, HdBufferSpecVector const &bufferSpecs, HdBufferArrayUsageHint usageHint)
Factory for creating HdBufferArray managed by HdStVBOMemoryManager aggregation.
virtual HDST_API HdBufferArrayRangeSharedPtr CreateBufferArrayRange()
Factory for creating HdBufferArrayRange managed by HdStVBOMemoryManager aggregation.
virtual HDST_API AggregationId ComputeAggregationId(HdBufferSpecVector const &bufferSpecs, HdBufferArrayUsageHint usageHint) const
Returns id for given bufferSpecs to be used for aggregation.
virtual HdBufferSpecVector GetBufferSpecs(HdBufferArraySharedPtr const &bufferArray) const
Returns the buffer specs from a given buffer array.
Token for efficient comparison, assignment, and hashing of known strings.
A map with string keys and VtValue values.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
HdTupleType represents zero, one, or more values of the same HdType.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...