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

specialized buffer array range More...

#include <interleavedMemoryManager.h>

+ Inheritance diagram for HdStInterleavedMemoryManager::_StripedInterleavedBufferRange:

Public Member Functions

 _StripedInterleavedBufferRange ()
 Constructor. More...
 
virtual HDST_API ~_StripedInterleavedBufferRange ()
 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 range 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
 
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 SetIndex (int index)
 Set the relative offset 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 57 of file interleavedMemoryManager.h.

Constructor & Destructor Documentation

HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::_StripedInterleavedBufferRange ( )
inline

Constructor.

Definition at line 60 of file interleavedMemoryManager.h.

virtual HDST_API HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::~_StripedInterleavedBufferRange ( )
virtual

Destructor.

Member Function Documentation

virtual HDST_API const void* HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::_GetAggregation ( ) const
protectedvirtual

Returns the aggregation container.

Implements HdBufferArrayRange.

virtual HDST_API void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::CopyData ( HdBufferSourceSharedPtr const bufferSource)
virtual

Copy source data into buffer.

Implements HdBufferArrayRange.

virtual HDST_API void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::DebugDump ( std::ostream &  out) const
virtual

Debug dump.

Implements HdBufferArrayRange.

virtual int HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetByteOffset ( TfToken const resourceName) const
inlinevirtual

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

Implements HdBufferArrayRange.

Definition at line 102 of file interleavedMemoryManager.h.

virtual int HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetElementOffset ( ) const
inlinevirtual

Returns the offset at which this range begins in the underlying buffer array in terms of elements.

Implements HdBufferArrayRange.

Definition at line 96 of file interleavedMemoryManager.h.

virtual HDST_API size_t HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetMaxNumElements ( ) const
virtual

Returns the max number of elements.

Implements HdBufferArrayRange.

virtual size_t HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetNumElements ( ) const
inlinevirtual

Returns the number of elements.

Implements HdBufferArrayRange.

Definition at line 110 of file interleavedMemoryManager.h.

virtual HDST_API HdStBufferResourceGLSharedPtr HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::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 HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetResource ( TfToken const name)
virtual

Returns the named GPU resource.

Implements HdStBufferArrayRangeGL.

virtual HDST_API HdStBufferResourceGLNamedList const& HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetResources ( ) const
virtual

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

Implements HdStBufferArrayRangeGL.

virtual HDST_API HdBufferArrayUsageHint HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetUsageHint ( ) const
overridevirtual

Returns the usage hint from the underlying buffer array.

Implements HdBufferArrayRange.

virtual size_t HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetVersion ( ) const
inlinevirtual

Returns the version of the buffer array.

Implements HdBufferArrayRange.

Definition at line 115 of file interleavedMemoryManager.h.

virtual void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::IncrementVersion ( )
inlinevirtual

Increment the version of the buffer array.

Implements HdBufferArrayRange.

Definition at line 120 of file interleavedMemoryManager.h.

void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::Invalidate ( )
inline

Make this range invalid.

Definition at line 159 of file interleavedMemoryManager.h.

virtual HDST_API bool HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::IsAssigned ( ) const
virtual

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

Implements HdBufferArrayRange.

virtual bool HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::IsImmutable ( ) const
virtual

Returns true if this range is marked as immutable.

Implements HdBufferArrayRange.

virtual bool HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::IsValid ( ) const
inlinevirtual

Returns true if this range is valid.

Implements HdBufferArrayRange.

Definition at line 69 of file interleavedMemoryManager.h.

virtual HDST_API VtValue HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::ReadData ( TfToken const name) const
virtual

Read back the buffer content.

Implements HdBufferArrayRange.

virtual HDST_API bool HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::Resize ( int  numElements)
virtual

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

Implements HdBufferArrayRange.

virtual HDST_API void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::SetBufferArray ( HdBufferArray bufferArray)
virtual

Sets the buffer array associated with this buffer;.

Implements HdBufferArrayRange.

void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::SetIndex ( int  index)
inline

Set the relative offset for this range.

Definition at line 154 of file interleavedMemoryManager.h.


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