HdStField Class Reference

Represents a Field Buffer Prim. More...

+ Inheritance diagram for HdStField:

Public Member Functions

HDST_API HdStField (SdfPath const &id, TfToken const &fieldType)
 For now, only fieldType HdStTokens->openvdbAsset is supported. More...
 
HDST_API void Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
 Loads field as 3d texture to generate GetFieldResource. More...
 
HDST_API HdDirtyBits GetInitialDirtyBitsMask () const override
 Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim. More...
 
HDST_API HdStTextureIdentifier const & GetTextureIdentifier () const
 Initialized by Sync. More...
 
size_t GetTextureMemory () const
 Get memory request for this field. More...
 
- Public Member Functions inherited from HdField
HD_API HdField (SdfPath const &id)
 
- Public Member Functions inherited from HdBprim
HD_API HdBprim (SdfPath const &id)
 
SdfPath const & GetId () const
 Returns the identifier by which this buffer is known. More...
 
virtual HD_API void Finalize (HdRenderParam *renderParam)
 Finalizes object resources. More...
 

Static Public Member Functions

static HDST_API const TfTokenVectorGetSupportedBprimTypes ()
 Bprim types handled by this class. More...
 
static HDST_API bool IsSupportedBprimType (const TfToken &bprimType)
 Can bprim type be handled by this class. More...
 

Additional Inherited Members

- Public Types inherited from HdField
enum  DirtyBits : HdDirtyBits { Clean = 0, DirtyTransform = 1 << 0, DirtyParams = 1 << 1, AllDirty }
 

Detailed Description

Represents a Field Buffer Prim.

Definition at line 39 of file field.h.

Constructor & Destructor Documentation

◆ HdStField()

HDST_API HdStField ( SdfPath const &  id,
TfToken const &  fieldType 
)

For now, only fieldType HdStTokens->openvdbAsset is supported.

Member Function Documentation

◆ GetInitialDirtyBitsMask()

HDST_API HdDirtyBits GetInitialDirtyBitsMask ( ) const
overridevirtual

Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.

Typically this would be all dirty bits.

Implements HdBprim.

◆ GetSupportedBprimTypes()

static HDST_API const TfTokenVector& GetSupportedBprimTypes ( )
static

Bprim types handled by this class.

◆ GetTextureIdentifier()

HDST_API HdStTextureIdentifier const& GetTextureIdentifier ( ) const
inline

Initialized by Sync.

Definition at line 58 of file field.h.

◆ GetTextureMemory()

size_t GetTextureMemory ( ) const
inline

Get memory request for this field.

Definition at line 63 of file field.h.

◆ IsSupportedBprimType()

static HDST_API bool IsSupportedBprimType ( const TfToken bprimType)
static

Can bprim type be handled by this class.

◆ Sync()

HDST_API void Sync ( HdSceneDelegate sceneDelegate,
HdRenderParam renderParam,
HdDirtyBits *  dirtyBits 
)
overridevirtual

Loads field as 3d texture to generate GetFieldResource.

Implements HdBprim.


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