specialized buffer array range More...

#include <interleavedMemoryManager.h>

Inheritance diagram for HdStInterleavedMemoryManager::_StripedInterleavedBufferRange:

Public Member Functions
	_StripedInterleavedBufferRange (HdStResourceRegistry *resourceRegistry)
	Constructor. More...

HDST_API	~_StripedInterleavedBufferRange () override
	Destructor. More...

bool	IsValid () const override
	Returns true if this range is valid. More...

HDST_API bool	IsAssigned () const override
	Returns true is the range has been assigned to a buffer. More...

bool	IsImmutable () const override
	Returns true if this range is marked as immutable. More...

bool	RequiresStaging () const override
	Returns true if this needs a staging buffer for CPU to GPU copies. More...

HDST_API bool	Resize (int numElements) override

HDST_API void	CopyData (HdBufferSourceSharedPtr const &bufferSource) override
	Copy source data into buffer. More...

HDST_API VtValue	ReadData (TfToken const &name) const override
	Read back the buffer content. More...

int	GetElementOffset () const override

int	GetByteOffset (TfToken const &resourceName) const override

size_t	GetNumElements () const override
	Returns the number of elements. More...

size_t	GetVersion () const override
	Returns the version of the buffer array. More...

int	GetElementStride () const override

void	IncrementVersion () override
	Increment the version of the buffer array. More...

HDST_API size_t	GetMaxNumElements () const override
	Returns the max number of elements. More...

HDST_API HdBufferArrayUsageHint	GetUsageHint () const override
	Returns the usage hint from the underlying buffer array. More...

HDST_API HdStBufferResourceSharedPtr	GetResource () const override

HDST_API HdStBufferResourceSharedPtr	GetResource (TfToken const &name) override
	Returns the named GPU resource. More...

HDST_API HdStBufferResourceNamedList const &	GetResources () const override
	Returns the list of all named GPU resources for this bufferArrayRange. More...

HDST_API void	SetBufferArray (HdBufferArray *bufferArray) override
	Sets the buffer array associated with this buffer;. More...

HDST_API void	DebugDump (std::ostream &out) const override
	Debug dump. More...

void	SetIndex (int index)
	Set the relative offset for this range. More...

void	Invalidate ()
	Make this range invalid. 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...

Public Member Functions inherited from HdStBufferArrayRange
	HdStBufferArrayRange (HdStResourceRegistry *resourceRegistry)

virtual HDST_API	~HdStBufferArrayRange ()

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
HDST_API const void *	_GetAggregation () const override
	Returns the aggregation container. More...

Protected Member Functions inherited from HdStBufferArrayRange
HdStResourceRegistry *	GetResourceRegistry ()

HdStResourceRegistry *	GetResourceRegistry () const

Protected Member Functions inherited from HdBufferArrayRange
	HdBufferArrayRange (const HdBufferArrayRange &)=delete

HdBufferArrayRange &	operator= (const HdBufferArrayRange &)=delete

Detailed Description

specialized buffer array range

Definition at line 59 of file interleavedMemoryManager.h.

Constructor & Destructor Documentation

HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::_StripedInterleavedBufferRange ( HdStResourceRegistry * resourceRegistry )

inline

Constructor.

Definition at line 63 of file interleavedMemoryManager.h.

HDST_API HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::~_StripedInterleavedBufferRange ( )

override

Destructor.

Member Function Documentation

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

overrideprotectedvirtual

Returns the aggregation container.

Implements HdBufferArrayRange.

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

overridevirtual

Copy source data into buffer.

Implements HdBufferArrayRange.

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

overridevirtual

Debug dump.

Implements HdBufferArrayRange.

int HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetByteOffset ( TfToken const & resourceName ) const

inlineoverridevirtual

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

Implements HdBufferArrayRange.

Definition at line 111 of file interleavedMemoryManager.h.

int HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetCapacity ( ) const

inline

Returns the capacity of allocated area.

Definition at line 177 of file interleavedMemoryManager.h.

int HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetElementOffset ( ) const

inlineoverridevirtual

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

Implements HdBufferArrayRange.

Definition at line 105 of file interleavedMemoryManager.h.

int HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetElementStride ( ) const

inlineoverridevirtual

Reimplemented from HdStBufferArrayRange.

Definition at line 128 of file interleavedMemoryManager.h.

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

overridevirtual

Returns the max number of elements.

Implements HdBufferArrayRange.

size_t HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetNumElements ( ) const

inlineoverridevirtual

Returns the number of elements.

Implements HdBufferArrayRange.

Definition at line 119 of file interleavedMemoryManager.h.

HDST_API HdStBufferResourceSharedPtr HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetResource ( ) const

overridevirtual

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

Implements HdStBufferArrayRange.

HDST_API HdStBufferResourceSharedPtr HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetResource ( TfToken const & name )

overridevirtual

Returns the named GPU resource.

Implements HdStBufferArrayRange.

HDST_API HdStBufferResourceNamedList const& HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetResources ( ) const

overridevirtual

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

Implements HdStBufferArrayRange.

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

overridevirtual

Returns the usage hint from the underlying buffer array.

Implements HdBufferArrayRange.

size_t HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::GetVersion ( ) const

inlineoverridevirtual

Returns the version of the buffer array.

Implements HdBufferArrayRange.

Definition at line 124 of file interleavedMemoryManager.h.

void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::IncrementVersion ( )

inlineoverridevirtual

Increment the version of the buffer array.

Implements HdBufferArrayRange.

Definition at line 133 of file interleavedMemoryManager.h.

void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::Invalidate ( )

inline

Make this range invalid.

Definition at line 172 of file interleavedMemoryManager.h.

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

overridevirtual

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

Implements HdBufferArrayRange.

bool HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::IsImmutable ( ) const

overridevirtual

Returns true if this range is marked as immutable.

Implements HdBufferArrayRange.

bool HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::IsValid ( ) const

inlineoverridevirtual

Returns true if this range is valid.

Implements HdBufferArrayRange.

Definition at line 75 of file interleavedMemoryManager.h.

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

overridevirtual

Read back the buffer content.

Implements HdBufferArrayRange.

bool HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::RequiresStaging ( ) const

overridevirtual

Returns true if this needs a staging buffer for CPU to GPU copies.

Implements HdBufferArrayRange.

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

overridevirtual

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

Implements HdBufferArrayRange.

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

overridevirtual

Sets the buffer array associated with this buffer;.

Implements HdBufferArrayRange.

void HdStInterleavedMemoryManager::_StripedInterleavedBufferRange::SetCapacity ( int capacity )

inline

Set the capacity of allocated area for this range.

Definition at line 182 of file interleavedMemoryManager.h.

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

inline

Set the relative offset for this range.

Definition at line 167 of file interleavedMemoryManager.h.

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

pxr/imaging/hdSt/interleavedMemoryManager.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation