The render engine state for a given rprim from the scene graph.
More...
#include <rprim.h>
|
virtual HdDirtyBits | GetInitialDirtyBitsMask () const =0 |
| Returns the set of dirty bits that should be added to the change tracker for this prim, when this prim is inserted.
|
|
HD_API bool | CanSkipDirtyBitPropagationAndSync (HdDirtyBits bits) const |
| This function gives an Rprim the chance to "early exit" from dirty bit propagation, delegate sync and rprim sync altogether.
|
|
HD_API HdDirtyBits | PropagateRprimDirtyBits (HdDirtyBits bits) |
| This function gives an Rprim the chance to set additional dirty bits based on those set in the change tracker, before passing the dirty bits to the scene delegate.
|
|
HD_API void | InitRepr (HdSceneDelegate *delegate, TfToken const &reprToken, HdDirtyBits *dirtyBits) |
| Initialize the representation of this Rprim by calling _InitRepr.
|
|
virtual void | Sync (HdSceneDelegate *delegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits, TfToken const &reprToken)=0 |
| Pull invalidated scene data and prepare/update the renderable representation.
|
|
virtual HdDirtyBits | _PropagateDirtyBits (HdDirtyBits bits) const =0 |
| This callback from Rprim gives the prim an opportunity to set additional dirty bits based on those already set.
|
|
virtual void | _InitRepr (TfToken const &reprToken, HdDirtyBits *dirtyBits)=0 |
| Initialize the given representation of this Rprim.
|
|
The render engine state for a given rprim from the scene graph.
All data access (aside from local caches) is delegated to the HdSceneDelegate.
Definition at line 37 of file rprim.h.
◆ _ReprVector
using _ReprVector = std::vector<std::pair<TfToken, HdReprSharedPtr> > |
|
protected |
◆ _InitRepr()
virtual void _InitRepr |
( |
TfToken const & |
reprToken, |
|
|
HdDirtyBits * |
dirtyBits |
|
) |
| |
|
protectedpure virtual |
Initialize the given representation of this Rprim.
This is called prior to syncing the prim, the first time the repr is used.
reprToken is the name of the representation to initalize.
dirtyBits is an in/out value. It is initialized to the dirty bits from the change tracker. InitRepr can then set additional dirty bits if additional data is required from the scene delegate when this repr is synced. InitRepr occurs before dirty bit propagation.
See HdRprim::InitRepr()
Implemented in HdEmbreeMesh, HdStBasisCurves, HdStMesh, HdStPoints, and HdStVolume.
◆ _PropagateDirtyBits()
virtual HdDirtyBits _PropagateDirtyBits |
( |
HdDirtyBits |
bits | ) |
const |
|
protectedpure virtual |
This callback from Rprim gives the prim an opportunity to set additional dirty bits based on those already set.
This is done before the dirty bits are passed to the scene delegate, so can be used to communicate that extra information is needed by the prim to process the changes.
The return value is the new set of dirty bits, which replaces the bits passed in.
See HdRprim::PropagateRprimDirtyBits()
Implemented in HdEmbreeMesh, HdStBasisCurves, HdStMesh, HdStPoints, and HdStVolume.
◆ CanSkipDirtyBitPropagationAndSync()
HD_API bool CanSkipDirtyBitPropagationAndSync |
( |
HdDirtyBits |
bits | ) |
const |
This function gives an Rprim the chance to "early exit" from dirty bit propagation, delegate sync and rprim sync altogether.
It is a temporary measure to prevent unnecessary work, like in the case of invisible prims. The dirty bits in the change tracker remain the same. See the implementation for the finer details.
◆ Finalize()
◆ GetBuiltinPrimvarNames()
virtual HD_API TfTokenVector const & GetBuiltinPrimvarNames |
( |
| ) |
const |
|
pure virtual |
◆ GetDrawItems()
HD_API const HdRepr::DrawItemUniquePtrVector & GetDrawItems |
( |
TfToken const & |
reprToken | ) |
const |
Returns the draw items for the requested repr token, if any.
These draw items should be constructed and cached beforehand by Sync(). If no draw items exist, or reprToken cannot be found, nullptr will be returned.
◆ GetExtent()
Returns the bounds of the rprim in local, untransformed space.
Definition at line 341 of file rprim.h.
◆ GetId()
Returns the identifier of this Rprim.
This is both used in the RenderIndex and the SceneDelegate and acts as the associative key for the Rprim in both contexts.
Definition at line 146 of file rprim.h.
◆ GetIndexedPrimvar()
◆ GetInitialDirtyBitsMask()
virtual HdDirtyBits GetInitialDirtyBitsMask |
( |
| ) |
const |
|
pure virtual |
◆ GetInstancerId()
SdfPath const & GetInstancerId |
( |
| ) |
const |
|
inline |
Returns the identifier of the instancer (if any) for this Rprim.
If this Rprim is not instanced, an empty SdfPath will be returned.
Definition at line 157 of file rprim.h.
◆ GetMaterialId()
SdfPath const & GetMaterialId |
( |
| ) |
const |
|
inline |
Returns the path of the material to which this Rprim is bound.
The material object itself can be fetched from the RenderIndex using this identifier.
Definition at line 162 of file rprim.h.
◆ GetPrimId()
int32_t GetPrimId |
( |
| ) |
const |
|
inline |
Return the unique instance id.
Definition at line 149 of file rprim.h.
◆ GetPrimvar()
◆ GetPrimvarDescriptors()
HdPrimvarDescriptorVector GetPrimvarDescriptors |
( |
HdSceneDelegate * |
delegate, |
|
|
HdInterpolation |
interpolation |
|
) |
| const |
|
inline |
Primvar Query.
Definition at line 347 of file rprim.h.
◆ GetRenderTag() [1/2]
TfToken const & GetRenderTag |
( |
| ) |
const |
|
inline |
◆ GetRenderTag() [2/2]
Returns the render tag associated to this rprim.
Definition at line 335 of file rprim.h.
◆ GetReprSelector()
◆ InitRepr()
Initialize the representation of this Rprim by calling _InitRepr.
This is called prior to dirty bit propagation & sync, the first time the repr is used, or when the authored representation is dirty.
dirtyBits is an in/out value. It is initialized to the dirty bits from the change tracker. InitRepr can then set additional dirty bits if additional data is required from the scene delegate when this repr is synced.
◆ IsDirty()
Returns true if any dirty flags are set for this rprim.
◆ IsVisible()
Is the prim itself visible.
Definition at line 207 of file rprim.h.
◆ PropagateRprimDirtyBits()
HD_API HdDirtyBits PropagateRprimDirtyBits |
( |
HdDirtyBits |
bits | ) |
|
This function gives an Rprim the chance to set additional dirty bits based on those set in the change tracker, before passing the dirty bits to the scene delegate.
It calls into _PropagateDirtyBits, which gives the Rprim an opportunity to specify the additional data needed to process the requested changes.
The return value is the new set of dirty bits.
◆ SetMaterialId()
HD_API void SetMaterialId |
( |
SdfPath const & |
materialId | ) |
|
Sets a new material binding to be used by this rprim.
◆ SetPrimId()
HD_API void SetPrimId |
( |
int32_t |
primId | ) |
|
Set the unique instance id.
◆ Sync()
Pull invalidated scene data and prepare/update the renderable representation.
This function is told which scene data to pull through the dirtyBits parameter. The first time it's called, dirtyBits comes from _GetInitialDirtyBits(), which provides initial dirty state, but after that it's driven by invalidation tracking in the scene delegate.
The contract for this function is that the prim can only pull on scene delegate buffers that are marked dirty. Scene delegates can and do implement just-in-time data schemes that mean that pulling on clean data will be at best incorrect, and at worst a crash.
This function is called in parallel from worker threads, so it needs to be threadsafe; calls into HdSceneDelegate are ok.
- Parameters
-
sceneDelegate | The data source for this geometry item. |
renderParam | A render delegate object that holds rendering parameters that scene geometry may use. |
dirtyBits | A specifier for which scene data has changed. |
reprToken | The representation that needs to be updated. This is useful for backends that support multiple display representations for an rprim. A given representation may choose to pull on a subset of the dirty state. |
dirtyBits | On input specifies which state is dirty and can be pulled from the scene delegate. On output specifies which bits are still dirty and were not cleaned by the sync. |
Implemented in HdStBasisCurves, HdStMesh, HdStPoints, HdStVolume, and HdEmbreeMesh.
◆ _authoredReprSelector
◆ _renderTag
◆ _reprs
◆ _sharedData
HdRprimSharedData _sharedData |
|
protected |
The documentation for this class was generated from the following file: