HdStBufferResource Class Reference

A GPU resource contained within an underlying HgiBuffer. More...

#include <bufferResource.h>

Public Member Functions
HDST_API	HdStBufferResource (TfToken const &role, HdTupleType tupleType, int offset, int stride)
TfToken const &	GetRole () const
	Returns the role of the data in this resource.
size_t	GetSize () const
	Returns the size (in bytes) of the data.
HdTupleType	GetTupleType () const
	Data type and count.
int	GetOffset () const
	Returns the interleaved offset (in bytes) of the data.
int	GetStride () const
	Returns the stride (in bytes) between data elements.
HDST_API void	SetAllocation (HgiBufferHandle const &handle, size_t size)
	Sets the HgiBufferHandle for this resource and its size.
HgiBufferHandle &	GetHandle ()
	Returns the HgiBufferHandle for this GPU resource.

Detailed Description

A GPU resource contained within an underlying HgiBuffer.

Definition at line 55 of file bufferResource.h.

Member Function Documentation

GetHandle()

HgiBufferHandle & GetHandle ( )

inline

Returns the HgiBufferHandle for this GPU resource.

Definition at line 87 of file bufferResource.h.

GetOffset()

int GetOffset ( ) const

inline

Returns the interleaved offset (in bytes) of the data.

Definition at line 77 of file bufferResource.h.

GetRole()

TfToken const & GetRole ( ) const

inline

Returns the role of the data in this resource.

Definition at line 68 of file bufferResource.h.

GetSize()

size_t GetSize ( ) const

inline

Returns the size (in bytes) of the data.

Definition at line 71 of file bufferResource.h.

GetStride()

int GetStride ( ) const

inline

Returns the stride (in bytes) between data elements.

Definition at line 80 of file bufferResource.h.

GetTupleType()

HdTupleType GetTupleType ( ) const

inline

Data type and count.

Definition at line 74 of file bufferResource.h.

SetAllocation()

HDST_API void SetAllocation	(	HgiBufferHandle const &	handle,
		size_t	size
	)

Sets the HgiBufferHandle for this resource and its size.

---

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

• pxr/imaging/hdSt/bufferResource.h