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

specialized buffer array range More...

#include <vboMemoryManager.h>

+ Inheritance diagram for HdStVBOMemoryManager::_StripedBufferArrayRange:

Public Member Functions

 _StripedBufferArrayRange ()
 Constructor. More...
 
virtual HDST_API ~_StripedBufferArrayRange ()
 Destructor. More...
 
virtual bool IsValid () const
 Returns true if this range is valid. More...
 
virtual HDST_API bool IsAssigned () const
 Returns true is the range has been assigned to a buffer. More...
 
virtual bool IsImmutable () const
 Returns true if this bar is marked as immutable. More...
 
virtual HDST_API bool Resize (int numElements)
 
virtual HDST_API void CopyData (HdBufferSourceSharedPtr const &bufferSource)
 Copy source data into buffer. More...
 
virtual HDST_API VtValue ReadData (TfToken const &name) const
 Read back the buffer content. More...
 
virtual int GetElementOffset () const
 Returns the relative element offset in aggregated buffer. More...
 
virtual int GetByteOffset (TfToken const &resourceName) const
 
virtual size_t GetNumElements () const
 Returns the number of elements. More...
 
virtual size_t GetVersion () const
 Returns the version of the buffer array. More...
 
virtual void IncrementVersion ()
 Increment the version of the buffer array. More...
 
virtual HDST_API size_t GetMaxNumElements () const
 Returns the max number of elements. More...
 
virtual HDST_API
HdBufferArrayUsageHint 
GetUsageHint () const override
 Returns the usage hint from the underlying buffer array. More...
 
virtual HDST_API
HdStBufferResourceGLSharedPtr 
GetResource () const
 
virtual HDST_API
HdStBufferResourceGLSharedPtr 
GetResource (TfToken const &name)
 Returns the named GPU resource. More...
 
virtual HDST_API
HdStBufferResourceGLNamedList
const
GetResources () const
 Returns the list of all named GPU resources for this bufferArrayRange. More...
 
virtual HDST_API void SetBufferArray (HdBufferArray *bufferArray)
 Sets the buffer array associated with this buffer;. More...
 
virtual HDST_API void DebugDump (std::ostream &out) const
 Debug dump. More...
 
void SetElementOffset (int offset)
 Set the relative offset for this range. More...
 
void SetNumElements (int numElements)
 Set the number of elements for this range. More...
 
int GetCapacity () const
 Returns the capacity of allocated area. More...
 
void SetCapacity (int capacity)
 Set the capacity of allocated area for this range. More...
 
void Invalidate ()
 Make this range invalid. More...
 
- Public Member Functions inherited from HdStBufferArrayRangeGL
virtual HDST_API ~HdStBufferArrayRangeGL ()
 
virtual HDST_API void GetBufferSpecs (HdBufferSpecVector *bufferSpecs) const override
 Sets the bufferSpecs for all resources. More...
 
- Public Member Functions inherited from HdBufferArrayRange
HD_API HdBufferArrayRange ()
 
virtual HD_API ~HdBufferArrayRange ()
 
bool IsAggregatedWith (HdBufferArrayRangeSharedPtr const &other) const
 Returns true if the underlying buffer array is aggregated to other's. More...
 

Protected Member Functions

virtual HDST_API const void_GetAggregation () const
 Returns the aggregation container. More...
 
- Protected Member Functions inherited from HdBufferArrayRange
 HdBufferArrayRange (const HdBufferArrayRange &)=delete
 
HdBufferArrayRangeoperator= (const HdBufferArrayRange &)=delete
 

Detailed Description

specialized buffer array range

Definition at line 88 of file vboMemoryManager.h.

Constructor & Destructor Documentation

HdStVBOMemoryManager::_StripedBufferArrayRange::_StripedBufferArrayRange ( )
inline

Constructor.

Definition at line 91 of file vboMemoryManager.h.

virtual HDST_API HdStVBOMemoryManager::_StripedBufferArrayRange::~_StripedBufferArrayRange ( )
virtual

Destructor.

Member Function Documentation

virtual HDST_API const void* HdStVBOMemoryManager::_StripedBufferArrayRange::_GetAggregation ( ) const
protectedvirtual

Returns the aggregation container.

Implements HdBufferArrayRange.

virtual HDST_API void HdStVBOMemoryManager::_StripedBufferArrayRange::CopyData ( HdBufferSourceSharedPtr const bufferSource)
virtual

Copy source data into buffer.

Implements HdBufferArrayRange.

virtual HDST_API void HdStVBOMemoryManager::_StripedBufferArrayRange::DebugDump ( std::ostream &  out) const
virtual

Debug dump.

Implements HdBufferArrayRange.

virtual int HdStVBOMemoryManager::_StripedBufferArrayRange::GetByteOffset ( TfToken const resourceName) const
virtual

Returns the byte offset at which this range begins in the underlying buffer array for the given resource.

Implements HdBufferArrayRange.

int HdStVBOMemoryManager::_StripedBufferArrayRange::GetCapacity ( ) const
inline

Returns the capacity of allocated area.

Definition at line 192 of file vboMemoryManager.h.

virtual int HdStVBOMemoryManager::_StripedBufferArrayRange::GetElementOffset ( ) const
inlinevirtual

Returns the relative element offset in aggregated buffer.

Implements HdBufferArrayRange.

Definition at line 129 of file vboMemoryManager.h.

virtual HDST_API size_t HdStVBOMemoryManager::_StripedBufferArrayRange::GetMaxNumElements ( ) const
virtual

Returns the max number of elements.

Implements HdBufferArrayRange.

virtual size_t HdStVBOMemoryManager::_StripedBufferArrayRange::GetNumElements ( ) const
inlinevirtual

Returns the number of elements.

Implements HdBufferArrayRange.

Definition at line 138 of file vboMemoryManager.h.

virtual HDST_API HdStBufferResourceGLSharedPtr HdStVBOMemoryManager::_StripedBufferArrayRange::GetResource ( ) const
virtual

Returns the GPU resource. If the buffer array contains more than one resource, this method raises a coding error.

Implements HdStBufferArrayRangeGL.

virtual HDST_API HdStBufferResourceGLSharedPtr HdStVBOMemoryManager::_StripedBufferArrayRange::GetResource ( TfToken const name)
virtual

Returns the named GPU resource.

Implements HdStBufferArrayRangeGL.

virtual HDST_API HdStBufferResourceGLNamedList const& HdStVBOMemoryManager::_StripedBufferArrayRange::GetResources ( ) const
virtual

Returns the list of all named GPU resources for this bufferArrayRange.

Implements HdStBufferArrayRangeGL.

virtual HDST_API HdBufferArrayUsageHint HdStVBOMemoryManager::_StripedBufferArrayRange::GetUsageHint ( ) const
overridevirtual

Returns the usage hint from the underlying buffer array.

Implements HdBufferArrayRange.

virtual size_t HdStVBOMemoryManager::_StripedBufferArrayRange::GetVersion ( ) const
inlinevirtual

Returns the version of the buffer array.

Implements HdBufferArrayRange.

Definition at line 143 of file vboMemoryManager.h.

virtual void HdStVBOMemoryManager::_StripedBufferArrayRange::IncrementVersion ( )
inlinevirtual

Increment the version of the buffer array.

Implements HdBufferArrayRange.

Definition at line 148 of file vboMemoryManager.h.

void HdStVBOMemoryManager::_StripedBufferArrayRange::Invalidate ( )
inline

Make this range invalid.

Definition at line 202 of file vboMemoryManager.h.

virtual HDST_API bool HdStVBOMemoryManager::_StripedBufferArrayRange::IsAssigned ( ) const
virtual

Returns true is the range has been assigned to a buffer.

Implements HdBufferArrayRange.

virtual bool HdStVBOMemoryManager::_StripedBufferArrayRange::IsImmutable ( ) const
virtual

Returns true if this bar is marked as immutable.

Implements HdBufferArrayRange.

virtual bool HdStVBOMemoryManager::_StripedBufferArrayRange::IsValid ( ) const
inlinevirtual

Returns true if this range is valid.

Implements HdBufferArrayRange.

Definition at line 104 of file vboMemoryManager.h.

virtual HDST_API VtValue HdStVBOMemoryManager::_StripedBufferArrayRange::ReadData ( TfToken const name) const
virtual

Read back the buffer content.

Implements HdBufferArrayRange.

virtual HDST_API bool HdStVBOMemoryManager::_StripedBufferArrayRange::Resize ( int  numElements)
virtual

Resize memory area for this range. Returns true if it causes container buffer reallocation.

Implements HdBufferArrayRange.

virtual HDST_API void HdStVBOMemoryManager::_StripedBufferArrayRange::SetBufferArray ( HdBufferArray bufferArray)
virtual

Sets the buffer array associated with this buffer;.

Implements HdBufferArrayRange.

void HdStVBOMemoryManager::_StripedBufferArrayRange::SetCapacity ( int  capacity)
inline

Set the capacity of allocated area for this range.

Definition at line 197 of file vboMemoryManager.h.

void HdStVBOMemoryManager::_StripedBufferArrayRange::SetElementOffset ( int  offset)
inline

Set the relative offset for this range.

Definition at line 182 of file vboMemoryManager.h.

void HdStVBOMemoryManager::_StripedBufferArrayRange::SetNumElements ( int  numElements)
inline

Set the number of elements for this range.

Definition at line 187 of file vboMemoryManager.h.


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