|
Tracks changes from the HdSceneDelegate, providing invalidation cues to the render engine. More...
#include <changeTracker.h>
Public Member Functions | |
Rprim Object Tracking | |
HD_API void | RprimInserted (SdfPath const &id, HdDirtyBits initialDirtyState) |
Start tracking Rprim with the given id . | |
HD_API void | RprimRemoved (SdfPath const &id) |
Stop tracking Rprim with the given id . | |
Task Object Tracking | |
HD_API void | TaskInserted (SdfPath const &id, HdDirtyBits initialDirtyState) |
Start tracking Task with the given id . | |
HD_API void | TaskRemoved (SdfPath const &id) |
Stop tracking Task with the given id . | |
HD_API void | MarkTaskDirty (SdfPath const &id, HdDirtyBits bits=AllDirty) |
Set the dirty flags to bits . | |
HD_API HdDirtyBits | GetTaskDirtyBits (SdfPath const &id) |
Get the dirty bits for Task with the given id . | |
HD_API void | MarkTaskClean (SdfPath const &id, HdDirtyBits newBits=Clean) |
Set the dirty flags to newBits . | |
HD_API unsigned | GetRenderTagVersion () const |
Retrieve the current version number of the rprim render tag set XXX Rename to GetRprimRenderTagVersion. | |
HD_API unsigned | GetTaskRenderTagsVersion () const |
Retrieve the current version number of the task's render tags opinion. | |
Instancer State Tracking | |
HD_API void | InstancerInserted (SdfPath const &id, HdDirtyBits initialDirtyState) |
Start tracking Instancer with the given id . | |
HD_API void | InstancerRemoved (SdfPath const &id) |
Stop tracking Instancer with the given id . | |
HD_API HdDirtyBits | GetInstancerDirtyBits (SdfPath const &id) |
Returns the dirty bits for the instancer with id . | |
HD_API void | MarkInstancerDirty (SdfPath const &id, HdDirtyBits bits=AllDirty) |
Flag the Instancer with the given id as being dirty. | |
HD_API void | MarkInstancerClean (SdfPath const &id, HdDirtyBits newBits=Clean) |
Clean the specified dirty bits for the instancer with id . | |
HD_API void | AddInstancerRprimDependency (SdfPath const &instancerId, SdfPath const &rprimId) |
Insert a dependency between rprimId and parent instancer instancerId . | |
HD_API void | RemoveInstancerRprimDependency (SdfPath const &instancerId, SdfPath const &rprimId) |
Remove a dependency between rprimId and parent instancer instancerId . | |
HD_API void | AddInstancerInstancerDependency (SdfPath const &parentInstancerId, SdfPath const &instancerId) |
Insert a dependency between instancerId and parent instancer parentInstancerId . | |
HD_API void | RemoveInstancerInstancerDependency (SdfPath const &parentInstancerId, SdfPath const &instancerId) |
Remove a dependency between instancerId and parent instancer parentInstancerId . | |
Sprim (scene state prim: camera, light, ...) state Tracking | |
HD_API void | SprimInserted (SdfPath const &id, HdDirtyBits initialDirtyState) |
Start tracking sprim with the given id . | |
HD_API void | SprimRemoved (SdfPath const &id) |
Stop tracking sprim with the given id . | |
HD_API HdDirtyBits | GetSprimDirtyBits (SdfPath const &id) |
Get the dirty bits for sprim with the given id . | |
HD_API void | MarkSprimDirty (SdfPath const &id, HdDirtyBits bits) |
Set the dirty flags to bits . | |
HD_API void | MarkSprimClean (SdfPath const &id, HdDirtyBits newBits=Clean) |
Set the dirty flags to newBits . | |
HD_API void | AddInstancerSprimDependency (SdfPath const &instancerId, SdfPath const &sprimId) |
Insert a dependency between sprimId and parent instancer instancerId . | |
HD_API void | RemoveInstancerSprimDependency (SdfPath const &instancerId, SdfPath const &sprimId) |
Remove a dependency between sprimId and parent instancer instancerId . | |
HD_API void | AddSprimSprimDependency (SdfPath const &parentSprimId, SdfPath const &sprimId) |
Insert a dependency between sprimId and parent sprim parentSprimId . | |
HD_API void | RemoveSprimSprimDependency (SdfPath const &parentSprimId, SdfPath const &sprimId) |
Remove a dependency between sprimId and parent sprim parentSprimId . | |
HD_API void | RemoveSprimFromSprimSprimDependencies (SdfPath const &sprimId) |
Remove all dependencies involving sprimId as a parent or child. | |
Bprim (buffer prim: texture, buffer, ...) state Tracking | |
HD_API void | BprimInserted (SdfPath const &id, HdDirtyBits initialDirtyState) |
Start tracking bprim with the given id . | |
HD_API void | BprimRemoved (SdfPath const &id) |
Stop tracking bprim with the given id . | |
HD_API HdDirtyBits | GetBprimDirtyBits (SdfPath const &id) |
Get the dirty bits for bprim with the given id . | |
HD_API void | MarkBprimDirty (SdfPath const &id, HdDirtyBits bits) |
Set the dirty flags to bits . | |
HD_API void | MarkBprimClean (SdfPath const &id, HdDirtyBits newBits=Clean) |
Set the dirty flags to newBits . | |
RprimCollection Tracking | |
HD_API void | AddCollection (TfToken const &collectionName) |
Adds a named collection for tracking. | |
HD_API void | MarkCollectionDirty (TfToken const &collectionName) |
Marks a named collection as being dirty, this bumps the version of the collection. | |
HD_API unsigned | GetCollectionVersion (TfToken const &collectionName) const |
Returns the current version of the named collection. | |
HD_API unsigned | GetVisibilityChangeCount () const |
Returns the number of changes to visibility. | |
HD_API unsigned | GetInstanceIndicesChangeCount () const |
Returns the number of changes to instance index. | |
unsigned | GetVaryingStateVersion () const |
Returns the current version of varying state. | |
Render Index Versioning | |
unsigned | GetRprimIndexVersion () const |
Returns the current version of the Render Index's RPrim set. | |
unsigned | GetSprimIndexVersion () const |
Returns the current version of the Render Index's SPrim set. | |
unsigned | GetBprimIndexVersion () const |
Returns the current version of the Render Index's BPrim set. | |
unsigned | GetInstancerIndexVersion () const |
Returns the current version of the Render Index's Instancer set. | |
unsigned | GetSceneStateVersion () const |
Returns the current version of the scene state. | |
General state tracking | |
HD_API void | AddState (TfToken const &name) |
Adds a named state for tracking. | |
HD_API void | MarkStateDirty (TfToken const &name) |
Marks a named state as being dirty., this bumps the version of the state. | |
HD_API unsigned | GetStateVersion (TfToken const &name) const |
Returns the current version of the named state. | |
Static Public Member Functions | |
Debug | |
static HD_API std::string | StringifyDirtyBits (HdDirtyBits dirtyBits) |
static HD_API void | DumpDirtyBits (HdDirtyBits dirtyBits) |
Friends | |
class | HdRenderIndex |
class | HdSceneIndexAdapterSceneDelegate |
Rprim State Tracking | |
HD_API HdDirtyBits | GetRprimDirtyBits (SdfPath const &id) const |
Returns the dirty bits for the rprim with id . | |
HD_API void | MarkRprimDirty (SdfPath const &id, HdDirtyBits bits=AllDirty) |
Flag the Rprim with the given id as being dirty. | |
HD_API void | MarkRprimClean (SdfPath const &id, HdDirtyBits newBits=Clean) |
Clear the dirty flags for an HdRprim. | |
HD_API void | MarkPrimvarDirty (SdfPath const &id, TfToken const &name) |
Mark the primvar for the rprim with id as being dirty. | |
HD_API void | MarkAllRprimsDirty (HdDirtyBits bits) |
Flag all the Rprim with the given id as being dirty. | |
HD_API void | ResetVaryingState () |
Clear Varying bit of all prims. | |
HD_API void | ResetRprimVaryingState (SdfPath const &id) |
Reset the varying state on one Rprim This is done for Rprims, where we choose not to clean them (due to state like invisibility). | |
HD_API bool | IsRprimDirty (SdfPath const &id) |
Returns true if the rprim identified by id has any dirty flags set. | |
HD_API bool | IsExtentDirty (SdfPath const &id) |
Returns true if the rprim identified by id has a dirty extent. | |
HD_API bool | IsDisplayStyleDirty (SdfPath const &id) |
Returns true if the rprim identified by id has a dirty display style. | |
HD_API bool | IsPrimvarDirty (SdfPath const &id, TfToken const &name) |
Returns true if the rprim identified by id with primvar name is dirty. | |
HD_API bool | IsAnyPrimvarDirty (SdfPath const &id) |
Returns true if the rprim identified by id has any dirty primvars. | |
HD_API bool | IsTopologyDirty (SdfPath const &id) |
Returns true if the rprim identified by id has a dirty topology. | |
HD_API bool | IsDoubleSidedDirty (SdfPath const &id) |
Returns true if the rprim identified by id has dirty doubleSided state. | |
HD_API bool | IsCullStyleDirty (SdfPath const &id) |
Returns true if the rprim identified by id has dirty cullstyle. | |
HD_API bool | IsSubdivTagsDirty (SdfPath const &id) |
Returns true if the rprim identified by id has a dirty subdiv tags. | |
HD_API bool | IsTransformDirty (SdfPath const &id) |
Returns true if the rprim identified by id has a dirty transform. | |
HD_API bool | IsVisibilityDirty (SdfPath const &id) |
Returns true if the rprim identified by id has dirty visibility. | |
HD_API bool | IsPrimIdDirty (SdfPath const &id) |
Returns true if the rprim identified by id has a dirty primID. | |
static bool | IsDirty (HdDirtyBits dirtyBits) |
Returns true if the dirtyBits has any flags set other than the varying flag. | |
static bool | IsClean (HdDirtyBits dirtyBits) |
Returns true if the dirtyBits has no flags set except the varying flag. | |
static bool | IsVarying (HdDirtyBits dirtyBits) |
Returns true if the varying flag is set. | |
static HD_API bool | IsExtentDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty extent. id is for perflog. | |
static HD_API bool | IsDisplayStyleDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty display style. id is for perflog. | |
static HD_API bool | IsSubdivTagsDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty subdiv tags. id is for perflog. | |
static HD_API bool | IsPrimvarDirty (HdDirtyBits dirtyBits, SdfPath const &id, TfToken const &name) |
Returns true if the dirtyBits has a dirty primvar name . | |
static HD_API bool | IsAnyPrimvarDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has any dirty primvars. | |
static HD_API bool | IsTopologyDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty topology. id is for perflog. | |
static HD_API bool | IsDoubleSidedDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has dirty doubleSided state. id is for perflog. | |
static HD_API bool | IsCullStyleDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has dirty cullstyle. id is for perflog. | |
static HD_API bool | IsTransformDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty transform. id is for perflog. | |
static HD_API bool | IsVisibilityDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has dirty visibility. id is for perflog. | |
static HD_API bool | IsPrimIdDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty primID. id is for perflog. | |
static HD_API bool | IsInstancerDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty instancer. id is for perflog. | |
static HD_API bool | IsInstanceIndexDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
Returns true if the dirtyBits has a dirty instance index. id is for perflog. | |
static HD_API bool | IsReprDirty (HdDirtyBits dirtyBits, SdfPath const &id) |
static HD_API void | MarkPrimvarDirty (HdDirtyBits *dirtyBits, TfToken const &name) |
Set the primvar dirty flag to dirtyBits . | |
Tracks changes from the HdSceneDelegate, providing invalidation cues to the render engine.
Changes flagged here are accumulated until the next time resource associated with the change is required, at which point the resource is updated and the flag is cleared.
Definition at line 34 of file changeTracker.h.
enum RprimDirtyBits : HdDirtyBits |
Definition at line 40 of file changeTracker.h.
enum TaskDirtyBits : HdDirtyBits |
Definition at line 80 of file changeTracker.h.
HD_API void AddCollection | ( | TfToken const & | collectionName | ) |
Adds a named collection for tracking.
HD_API void AddInstancerInstancerDependency | ( | SdfPath const & | parentInstancerId, |
SdfPath const & | instancerId | ||
) |
Insert a dependency between instancerId
and parent instancer parentInstancerId
.
Changes to the latter mark the former with DirtyInstancer.
Insert a dependency between rprimId
and parent instancer instancerId
.
Changes to the latter mark the former with DirtyInstancer.
Insert a dependency between sprimId
and parent instancer instancerId
.
Changes to the latter mark the former with DirtyInstancer.
Insert a dependency between sprimId
and parent sprim parentSprimId
.
HD_API void AddState | ( | TfToken const & | name | ) |
Adds a named state for tracking.
HD_API void BprimInserted | ( | SdfPath const & | id, |
HdDirtyBits | initialDirtyState | ||
) |
Start tracking bprim with the given id
.
HD_API void BprimRemoved | ( | SdfPath const & | id | ) |
Stop tracking bprim with the given id
.
HD_API HdDirtyBits GetBprimDirtyBits | ( | SdfPath const & | id | ) |
Get the dirty bits for bprim with the given id
.
|
inline |
Returns the current version of the Render Index's BPrim set.
This version number changes when Bprims are inserted or removed from the render index. Invalidating any cached gather operations.
Definition at line 511 of file changeTracker.h.
HD_API unsigned GetCollectionVersion | ( | TfToken const & | collectionName | ) | const |
Returns the current version of the named collection.
HD_API unsigned GetInstanceIndicesChangeCount | ( | ) | const |
Returns the number of changes to instance index.
This is intended to be used to detect when instance indices changed for any Rprim. Use in with GetInstancerIndexVersion() to detect all changes to instance indices.
HD_API HdDirtyBits GetInstancerDirtyBits | ( | SdfPath const & | id | ) |
Returns the dirty bits for the instancer with id
.
|
inline |
Returns the current version of the Render Index's Instancer set.
This version number changes when Instancers are inserted or removed from the render index. Invalidating any cached gather operations.
Definition at line 518 of file changeTracker.h.
HD_API unsigned GetRenderTagVersion | ( | ) | const |
Retrieve the current version number of the rprim render tag set XXX Rename to GetRprimRenderTagVersion.
HD_API HdDirtyBits GetRprimDirtyBits | ( | SdfPath const & | id | ) | const |
Returns the dirty bits for the rprim with id
.
|
inline |
Returns the current version of the Render Index's RPrim set.
This version number changes when Rprims are inserted or removed from the render index. Invalidating any cached gather operations.
Definition at line 497 of file changeTracker.h.
|
inline |
Returns the current version of the scene state.
This version number changes whenever any prims are inserted, removed or marked dirty. The use case is to detect that nothing has changed, so the Sync phase can be avoided.
Definition at line 528 of file changeTracker.h.
HD_API HdDirtyBits GetSprimDirtyBits | ( | SdfPath const & | id | ) |
Get the dirty bits for sprim with the given id
.
|
inline |
Returns the current version of the Render Index's SPrim set.
This version number changes when Sprims are inserted or removed from the render index. Invalidating any cached gather operations.
Definition at line 504 of file changeTracker.h.
HD_API unsigned GetStateVersion | ( | TfToken const & | name | ) | const |
Returns the current version of the named state.
HD_API HdDirtyBits GetTaskDirtyBits | ( | SdfPath const & | id | ) |
Get the dirty bits for Task with the given id
.
HD_API unsigned GetTaskRenderTagsVersion | ( | ) | const |
Retrieve the current version number of the task's render tags opinion.
|
inline |
Returns the current version of varying state.
This is used to refresh cached DirtyLists
Definition at line 484 of file changeTracker.h.
HD_API unsigned GetVisibilityChangeCount | ( | ) | const |
Returns the number of changes to visibility.
This is intended to be used to detect when visibility has changed for any Rprim.
HD_API void InstancerInserted | ( | SdfPath const & | id, |
HdDirtyBits | initialDirtyState | ||
) |
Start tracking Instancer with the given id
.
HD_API void InstancerRemoved | ( | SdfPath const & | id | ) |
Stop tracking Instancer with the given id
.
|
static |
Returns true if the dirtyBits has any dirty primvars.
id is for perflog.
HD_API bool IsAnyPrimvarDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has any dirty primvars.
|
inlinestatic |
Returns true if the dirtyBits has no flags set except the varying flag.
Definition at line 210 of file changeTracker.h.
|
static |
Returns true if the dirtyBits has dirty cullstyle. id is for perflog.
HD_API bool IsCullStyleDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has dirty cullstyle.
|
inlinestatic |
Returns true if the dirtyBits has any flags set other than the varying flag.
Definition at line 205 of file changeTracker.h.
|
static |
Returns true if the dirtyBits has a dirty display style. id is for perflog.
HD_API bool IsDisplayStyleDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has a dirty display style.
|
static |
Returns true if the dirtyBits has dirty doubleSided state. id is for perflog.
HD_API bool IsDoubleSidedDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has dirty doubleSided state.
|
static |
Returns true if the dirtyBits has a dirty extent. id is for perflog.
HD_API bool IsExtentDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has a dirty extent.
|
static |
Returns true if the dirtyBits has a dirty instance index. id is for perflog.
|
static |
Returns true if the dirtyBits has a dirty instancer. id is for perflog.
|
static |
Returns true if the dirtyBits has a dirty primID. id is for perflog.
HD_API bool IsPrimIdDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has a dirty primID.
|
static |
Returns true if the dirtyBits has a dirty primvar name
.
id is for perflog.
Returns true if the rprim identified by id
with primvar name
is dirty.
HD_API bool IsRprimDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has any dirty flags set.
|
static |
Returns true if the dirtyBits has a dirty subdiv tags. id is for perflog.
HD_API bool IsSubdivTagsDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has a dirty subdiv tags.
|
static |
Returns true if the dirtyBits has a dirty topology. id is for perflog.
HD_API bool IsTopologyDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has a dirty topology.
|
static |
Returns true if the dirtyBits has a dirty transform. id is for perflog.
HD_API bool IsTransformDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has a dirty transform.
|
inlinestatic |
Returns true if the varying flag is set.
Definition at line 215 of file changeTracker.h.
|
static |
Returns true if the dirtyBits has dirty visibility. id is for perflog.
HD_API bool IsVisibilityDirty | ( | SdfPath const & | id | ) |
Returns true if the rprim identified by id
has dirty visibility.
HD_API void MarkAllRprimsDirty | ( | HdDirtyBits | bits | ) |
Flag all the Rprim with the given id
as being dirty.
Multiple calls with different dirty bits accumulate. Doesn't touch varying state.
HD_API void MarkBprimClean | ( | SdfPath const & | id, |
HdDirtyBits | newBits = Clean |
||
) |
Set the dirty flags to newBits
.
HD_API void MarkBprimDirty | ( | SdfPath const & | id, |
HdDirtyBits | bits | ||
) |
Set the dirty flags to bits
.
HD_API void MarkCollectionDirty | ( | TfToken const & | collectionName | ) |
Marks a named collection as being dirty, this bumps the version of the collection.
HD_API void MarkInstancerClean | ( | SdfPath const & | id, |
HdDirtyBits | newBits = Clean |
||
) |
Clean the specified dirty bits for the instancer with id
.
HD_API void MarkInstancerDirty | ( | SdfPath const & | id, |
HdDirtyBits | bits = AllDirty |
||
) |
Flag the Instancer with the given id
as being dirty.
Multiple calls with different dirty bits accumulate.
|
static |
Set the primvar dirty flag to dirtyBits
.
Mark the primvar for the rprim with id
as being dirty.
HD_API void MarkRprimClean | ( | SdfPath const & | id, |
HdDirtyBits | newBits = Clean |
||
) |
Clear the dirty flags for an HdRprim.
if inSync is true, set OutOfSync flag to notify dirtyList will discover the prim to sync the residual data for new repr.
HD_API void MarkRprimDirty | ( | SdfPath const & | id, |
HdDirtyBits | bits = AllDirty |
||
) |
Flag the Rprim with the given id
as being dirty.
Multiple calls with different dirty bits accumulate.
HD_API void MarkSprimClean | ( | SdfPath const & | id, |
HdDirtyBits | newBits = Clean |
||
) |
Set the dirty flags to newBits
.
HD_API void MarkSprimDirty | ( | SdfPath const & | id, |
HdDirtyBits | bits | ||
) |
Set the dirty flags to bits
.
HD_API void MarkStateDirty | ( | TfToken const & | name | ) |
Marks a named state as being dirty., this bumps the version of the state.
HD_API void MarkTaskClean | ( | SdfPath const & | id, |
HdDirtyBits | newBits = Clean |
||
) |
Set the dirty flags to newBits
.
HD_API void MarkTaskDirty | ( | SdfPath const & | id, |
HdDirtyBits | bits = AllDirty |
||
) |
Set the dirty flags to bits
.
HD_API void RemoveInstancerInstancerDependency | ( | SdfPath const & | parentInstancerId, |
SdfPath const & | instancerId | ||
) |
Remove a dependency between instancerId
and parent instancer parentInstancerId
.
Remove a dependency between rprimId
and parent instancer instancerId
.
Remove a dependency between sprimId
and parent instancer instancerId
.
HD_API void RemoveSprimFromSprimSprimDependencies | ( | SdfPath const & | sprimId | ) |
Remove all dependencies involving sprimId
as a parent or child.
Remove a dependency between sprimId
and parent sprim parentSprimId
.
HD_API void ResetRprimVaryingState | ( | SdfPath const & | id | ) |
Reset the varying state on one Rprim This is done for Rprims, where we choose not to clean them (due to state like invisibility).
HD_API void ResetVaryingState | ( | ) |
Clear Varying bit of all prims.
The idea is that from frame to frame (update iteration), the set of dirty rprims and their dirty bits do not change; that is, the same rprims get dirtied with the same dirty bits.. The change tracker can leverage this help build a stable dirty list and reduce the overall cost of an update iteration.
HD_API void RprimInserted | ( | SdfPath const & | id, |
HdDirtyBits | initialDirtyState | ||
) |
Start tracking Rprim with the given id
.
HD_API void RprimRemoved | ( | SdfPath const & | id | ) |
Stop tracking Rprim with the given id
.
HD_API void SprimInserted | ( | SdfPath const & | id, |
HdDirtyBits | initialDirtyState | ||
) |
Start tracking sprim with the given id
.
HD_API void SprimRemoved | ( | SdfPath const & | id | ) |
Stop tracking sprim with the given id
.
HD_API void TaskInserted | ( | SdfPath const & | id, |
HdDirtyBits | initialDirtyState | ||
) |
Start tracking Task with the given id
.
HD_API void TaskRemoved | ( | SdfPath const & | id | ) |
Stop tracking Task with the given id
.
|
friend |
Definition at line 654 of file changeTracker.h.
|
friend |
Definition at line 668 of file changeTracker.h.