HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStBufferArrayRegistry Class Reference

#include <bufferArrayRegistry.h>

Public Member Functions

 HF_MALLOC_TAG_NEW ("new HdStBufferArrayRegistry")
 
HDST_API HdStBufferArrayRegistry ()
 
 ~HdStBufferArrayRegistry ()=default
 
HDST_API
HdBufferArrayRangeSharedPtr 
AllocateRange (HdStAggregationStrategy *strategy, TfToken const &role, HdBufferSpecVector const &bufferSpecs, HdBufferArrayUsageHint usageHint)
 
HDST_API void ReallocateAll (HdStAggregationStrategy *strategy)
 Triggers reallocation on all buffers managed by the registry. More...
 
HDST_API void GarbageCollect ()
 Frees up buffers that no longer contain any allocated ranges. More...
 
HDST_API size_t GetResourceAllocation (HdStAggregationStrategy *strategy, VtDictionary &result) const
 

Friends

HDST_API friend std::ostream & operator<< (std::ostream &out, const HdStBufferArrayRegistry &self)
 Debug dump. More...
 

Detailed Description

Manages the pool of buffer arrays.

Definition at line 55 of file bufferArrayRegistry.h.

Constructor & Destructor Documentation

HDST_API HdStBufferArrayRegistry::HdStBufferArrayRegistry ( )
HdStBufferArrayRegistry::~HdStBufferArrayRegistry ( )
default

Member Function Documentation

HDST_API HdBufferArrayRangeSharedPtr HdStBufferArrayRegistry::AllocateRange ( HdStAggregationStrategy strategy,
TfToken const role,
HdBufferSpecVector const bufferSpecs,
HdBufferArrayUsageHint  usageHint 
)

Allocate new buffer array range using strategy Thread-Safe

HDST_API void HdStBufferArrayRegistry::GarbageCollect ( )

Frees up buffers that no longer contain any allocated ranges.

HDST_API size_t HdStBufferArrayRegistry::GetResourceAllocation ( HdStAggregationStrategy strategy,
VtDictionary result 
) const

Generate a report on resources consumed by the managed buffer array. The returned size is an esitmate of the gpu memory consumed by the buffers

HdStBufferArrayRegistry::HF_MALLOC_TAG_NEW ( "new HdStBufferArrayRegistry )
HDST_API void HdStBufferArrayRegistry::ReallocateAll ( HdStAggregationStrategy strategy)

Triggers reallocation on all buffers managed by the registry.

Friends And Related Function Documentation

HDST_API friend std::ostream& operator<< ( std::ostream &  out,
const HdStBufferArrayRegistry self 
)
friend

Debug dump.


The documentation for this class was generated from the following file: