Represents a Field Buffer Prim.
More...
#include <field.h>
|
HDST_API | HdStField (SdfPath const &id, TfToken const &fieldType) |
| For now, only fieldType HdStTokens->openvdbAsset is supported.
|
|
HDST_API void | Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override |
| Loads field as 3d texture to generate GetFieldResource.
|
|
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.
|
|
HDST_API HdStTextureIdentifier const & | GetTextureIdentifier () const |
| Initialized by Sync.
|
|
size_t | GetTextureMemory () const |
| Get memory request for this field.
|
|
HD_API | HdField (SdfPath const &id) |
|
HD_API | HdBprim (SdfPath const &id) |
|
SdfPath const & | GetId () const |
| Returns the identifier by which this buffer is known.
|
|
virtual void | Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits)=0 |
| Synchronizes state from the delegate to this object.
|
|
virtual HD_API void | Finalize (HdRenderParam *renderParam) |
| Finalizes object resources.
|
|
virtual HdDirtyBits | GetInitialDirtyBitsMask () const =0 |
| Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.
|
|
|
enum | DirtyBits : HdDirtyBits { Clean = 0
, DirtyTransform = 1 << 0
, DirtyParams = 1 << 1
, AllDirty
} |
|
Represents a Field Buffer Prim.
Definition at line 22 of file field.h.
◆ HdStField()
For now, only fieldType HdStTokens->openvdbAsset is supported.
◆ 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()
Bprim types handled by this class.
◆ GetTextureIdentifier()
Initialized by Sync.
Definition at line 41 of file field.h.
◆ GetTextureMemory()
size_t GetTextureMemory |
( |
| ) |
const |
|
inline |
Get memory request for this field.
Definition at line 46 of file field.h.
◆ IsSupportedBprimType()
static HDST_API bool IsSupportedBprimType |
( |
const TfToken & |
bprimType | ) |
|
|
static |
Can bprim type be handled by this class.
◆ Sync()
Loads field as 3d texture to generate GetFieldResource.
Implements HdBprim.
The documentation for this class was generated from the following file: