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

#include <bufferResourceGL.h>

+ Inheritance diagram for HdStBufferResourceGL:

Public Member Functions

HDST_API HdStBufferResourceGL (TfToken const &role, HdTupleType tupleType, int offset, int stride)
 
HDST_API ~HdStBufferResourceGL ()
 
HDST_API void SetAllocation (HgiBufferHandle const &id, size_t size)
 
HgiBufferHandleGetId ()
 Returns the Hgi id for this GPU resource. More...
 
uint64_t GetGPUAddress () const
 Returns the gpu address (if available. otherwise returns 0). More...
 
- Public Member Functions inherited from HdBufferResource
HD_API HdBufferResource (TfToken const &role, HdTupleType tupleType, int offset, int stride)
 
HD_API ~HdBufferResource ()
 
HdTupleType GetTupleType () const
 Data type and count. More...
 
int GetOffset () const
 Returns the interleaved offset (in bytes) of this data. More...
 
int GetStride () const
 Returns the stride (in bytes) of underlying buffer. More...
 
- Public Member Functions inherited from HdResource
HD_API HdResource (TfToken const &role)
 
virtual HD_API ~HdResource ()
 
TfToken constGetRole () const
 Returns the role of the GPU data in this resource. More...
 
HD_API size_t GetSize () const
 Returns the size of the resource allocated in the GPU. More...
 

Additional Inherited Members

- Protected Member Functions inherited from HdResource
HD_API void SetSize (size_t size)
 Stores the size of the resource allocated in the GPU. More...
 
- Protected Attributes inherited from HdBufferResource
HdTupleType _tupleType
 
int _offset
 
int _stride
 

Detailed Description

A specific type of HdBufferResource (GPU resource) representing an OpenGL buffer object.

Definition at line 58 of file bufferResourceGL.h.

Constructor & Destructor Documentation

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

Member Function Documentation

uint64_t HdStBufferResourceGL::GetGPUAddress ( ) const
inline

Returns the gpu address (if available. otherwise returns 0).

Definition at line 78 of file bufferResourceGL.h.

HgiBufferHandle& HdStBufferResourceGL::GetId ( )
inline

Returns the Hgi id for this GPU resource.

Definition at line 75 of file bufferResourceGL.h.

HDST_API void HdStBufferResourceGL::SetAllocation ( HgiBufferHandle const id,
size_t  size 
)

Sets the OpenGL name/identifier for this resource and its size. also caches the gpu address of the buffer.


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