HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdStBufferResource Class Referencefinal

#include <bufferResource.h>

Public Member Functions

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

Detailed Description

A GPU resource contained within an underlying HgiBuffer.

Definition at line 55 of file bufferResource.h.

Constructor & Destructor Documentation

HDST_API HdStBufferResource::HdStBufferResource ( TfToken const &  role,
HdTupleType  tupleType,
int  offset,
int  stride 
)
HDST_API HdStBufferResource::~HdStBufferResource ( )

Member Function Documentation

HgiBufferHandle& HdStBufferResource::GetHandle ( )
inline

Returns the HgiBufferHandle for this GPU resource.

Definition at line 87 of file bufferResource.h.

int HdStBufferResource::GetOffset ( ) const
inline

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

Definition at line 77 of file bufferResource.h.

TfToken const& HdStBufferResource::GetRole ( ) const
inline

Returns the role of the data in this resource.

Definition at line 68 of file bufferResource.h.

size_t HdStBufferResource::GetSize ( ) const
inline

Returns the size (in bytes) of the data.

Definition at line 71 of file bufferResource.h.

int HdStBufferResource::GetStride ( ) const
inline

Returns the stride (in bytes) between data elements.

Definition at line 80 of file bufferResource.h.

HdTupleType HdStBufferResource::GetTupleType ( ) const
inline

Data type and count.

Definition at line 74 of file bufferResource.h.

HDST_API void HdStBufferResource::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: