The Hydra render index is a flattened representation of the client scene graph, which may be composed of several self-contained scene graphs, each of which provides a HdSceneDelegate adapter for data access. More...
Public Types | |
typedef std::vector < HdDrawItem const * > | HdDrawItemPtrVector |
Public Member Functions | |
HD_API void | Clear () |
Clear all r (render), s (state) and b (buffer) prims. More... | |
HD_API void | RemoveSubtree (const SdfPath &root, HdSceneDelegate *sceneDelegate) |
Clear all entries in the render index under the given root and belong to a specified delegate. More... | |
HD_API SdfPath | GetRprimPathFromPrimId (int primId) const |
Given a prim id, returns the path of the corresponding rprim or an empty path if none is found. More... | |
Synchronization | |
HD_API void | EnqueuePrimsToSync (HdDirtyListSharedPtr const &dirtyList, HdRprimCollection const &collection) |
Adds the dirty list to the sync queue. More... | |
HD_API void | SyncAll (HdTaskSharedPtrVector *tasks, HdTaskContext *taskContext) |
Syncs input tasks, B & S prims, (external) computations and processes all pending dirty lists (which syncs the R prims). More... | |
Execution | |
HD_API HdDrawItemPtrVector | GetDrawItems (HdRprimCollection const &collection, TfTokenVector const &renderTags) |
Returns a list of relevant draw items that match the criteria specified. More... | |
Change Tracker | |
HdChangeTracker & | GetChangeTracker () |
HdChangeTracker const & | GetChangeTracker () const |
Renderable prims (e.g. meshes, basis curves) | |
HD_API bool | IsRprimTypeSupported (TfToken const &typeId) const |
Returns whether the rprim type is supported by this render index. More... | |
HD_API void | InsertRprim (TfToken const &typeId, HdSceneDelegate *sceneDelegate, SdfPath const &rprimId) |
Insert a rprim into index. More... | |
HD_API void | RemoveRprim (SdfPath const &id) |
Remove a rprim from index. More... | |
bool | HasRprim (SdfPath const &id) |
Returns true if rprim id exists in index. More... | |
HD_API HdRprim const * | GetRprim (SdfPath const &id) const |
Returns the rprim of id. More... | |
HD_API HdSceneDelegate * | GetSceneDelegateForRprim (SdfPath const &id) const |
Returns the scene delegate for the given rprim. More... | |
HD_API bool | GetSceneDelegateAndInstancerIds (SdfPath const &id, SdfPath *sceneDelegateId, SdfPath *instancerId) const |
Query function to return the id's of the scene delegate and instancer associated with the Rprim at the given path. More... | |
HD_API TfToken | GetRenderTag (SdfPath const &id) const |
Returns the render tag for the given rprim. More... | |
HD_API TfToken | GetMaterialTag (SdfPath const &id) const |
Return the material tag for the given rprim. More... | |
HD_API const SdfPathVector & | GetRprimIds () |
Returns a sorted list of all Rprims in the render index. More... | |
HD_API SdfPathVector | GetRprimSubtree (SdfPath const &root) |
Returns the subtree rooted under the given path. More... | |
Instancer Support | |
HD_API void | InsertInstancer (HdSceneDelegate *delegate, SdfPath const &id) |
Insert an instancer into index. More... | |
HD_API void | RemoveInstancer (SdfPath const &id) |
Remove an instancer from index. More... | |
bool | HasInstancer (SdfPath const &id) |
Returns true if instancer id exists in index. More... | |
HD_API HdInstancer * | GetInstancer (SdfPath const &id) const |
Returns the instancer of id. More... | |
Task Support | |
template<typename T > | |
void | InsertTask (HdSceneDelegate *delegate, SdfPath const &id) |
Inserts a new task into the render index with an identifier of id . More... | |
HD_API void | RemoveTask (SdfPath const &id) |
Removes the given task from the RenderIndex. More... | |
bool | HasTask (SdfPath const &id) |
Returns true if a task exists in the index with the given id . More... | |
HD_API HdTaskSharedPtr const & | GetTask (SdfPath const &id) const |
Returns the task for the given id . More... | |
Scene state prims (e.g. camera, light) | |
HD_API bool | IsSprimTypeSupported (TfToken const &typeId) const |
Returns whether the sprim type is supported by this render index. More... | |
HD_API void | InsertSprim (TfToken const &typeId, HdSceneDelegate *delegate, SdfPath const &sprimId) |
Insert a sprim into index. More... | |
HD_API void | RemoveSprim (TfToken const &typeId, SdfPath const &id) |
HD_API HdSprim * | GetSprim (TfToken const &typeId, SdfPath const &id) const |
HD_API SdfPathVector | GetSprimSubtree (TfToken const &typeId, SdfPath const &root) |
Returns the subtree rooted under the given path for the given sprim type. More... | |
HD_API HdSprim * | GetFallbackSprim (TfToken const &typeId) const |
Returns the fullback prim for the Sprim of the given type. More... | |
Buffer prims (e.g. textures, buffers) | |
HD_API bool | IsBprimTypeSupported (TfToken const &typeId) const |
Returns whether the bprim type is supported by this render index. More... | |
HD_API void | InsertBprim (TfToken const &typeId, HdSceneDelegate *delegate, SdfPath const &bprimId) |
Insert a bprim into index. More... | |
HD_API void | RemoveBprim (TfToken const &typeId, SdfPath const &id) |
HD_API HdBprim * | GetBprim (TfToken const &typeId, SdfPath const &id) const |
HD_API SdfPathVector | GetBprimSubtree (TfToken const &typeId, SdfPath const &root) |
Returns the subtree rooted under the given path for the given bprim type. More... | |
HD_API HdBprim * | GetFallbackBprim (TfToken const &typeId) const |
Returns the fallback prim for the Bprim of the given type. More... | |
Static Public Member Functions | |
static HD_API HdRenderIndex * | New (HdRenderDelegate *renderDelegate, HdDriverVector const &drivers) |
Create a render index with the given render delegate. More... | |
Render Delegate | |
class | HdDirtyList |
HD_API HdRenderDelegate * | GetRenderDelegate () const |
Currently, a render index only supports connection to one type of render delegate, due to the inserted information and change tracking being specific to that delegate type. More... | |
HD_API HdDriverVector const & | GetDrivers () const |
HD_API HdResourceRegistrySharedPtr | GetResourceRegistry () const |
Returns a shared ptr to the resource registry of the current render delegate. More... | |
The Hydra render index is a flattened representation of the client scene graph, which may be composed of several self-contained scene graphs, each of which provides a HdSceneDelegate adapter for data access.
Thus, multiple HdSceneDelegate's may be tied to the same HdRenderIndex.
The render index, however, is tied to a single HdRenderDelegate, which handles the actual creation and deletion of Hydra scene primitives. These include geometry and non-drawable objects (such as the camera and texture buffers). The render index simply holds a handle to these primitives, and tracks any changes to them via the HdChangeTracker. It also tracks computations and tasks that may update resources and render a subset of the renderable primitives.
The render index orchestrates the "syncing" of scene primitives, by providing the relevant scene delegate for data access, and leaves resource management to the rendering backend (via HdResourceRegistry).
It also provides "execution" functionality for application facing Hydra concepts (such as HdTask/HdRenderPass) in computing the set of HdDrawItems for a given HdRprimCollection, for rendering.
If two viewers use different HdRenderDelegate's, then it may unfortunately require populating two HdRenderIndex's.
Definition at line 116 of file renderIndex.h.
HD_API void Clear | ( | ) |
Clear all r (render), s (state) and b (buffer) prims.
HD_API void EnqueuePrimsToSync | ( | HdDirtyListSharedPtr const & | dirtyList, |
HdRprimCollection const & | collection | ||
) |
Adds the dirty list to the sync queue.
The actual processing of the dirty list happens later in SyncAll().
This is typically called from HdRenderPass::Sync. However, the current call chain ties it to SyncAll, i.e. HdRenderIndex::SyncAll > .... > HdRenderPass::Sync > HdRenderIndex::Sync
Returns the subtree rooted under the given path for the given bprim type.
HD_API HdDrawItemPtrVector GetDrawItems | ( | HdRprimCollection const & | collection, |
TfTokenVector const & | renderTags | ||
) |
Returns a list of relevant draw items that match the criteria specified.
The is typically called during render pass execution, which is the final phase in the Hydra's execution. See HdRenderPass::Execute
Returns the fallback prim for the Bprim of the given type.
Returns the fullback prim for the Sprim of the given type.
HD_API HdInstancer* GetInstancer | ( | SdfPath const & | id | ) | const |
Returns the instancer of id.
Return the material tag for the given rprim.
HD_API HdRenderDelegate* GetRenderDelegate | ( | ) | const |
Currently, a render index only supports connection to one type of render delegate, due to the inserted information and change tracking being specific to that delegate type.
HD_API HdResourceRegistrySharedPtr GetResourceRegistry | ( | ) | const |
Returns a shared ptr to the resource registry of the current render delegate.
|
inline |
Returns a sorted list of all Rprims in the render index.
The list is sorted by std::less<SdfPath>
Definition at line 245 of file renderIndex.h.
HD_API SdfPath GetRprimPathFromPrimId | ( | int | primId | ) | const |
Given a prim id, returns the path of the corresponding rprim or an empty path if none is found.
HD_API SdfPathVector GetRprimSubtree | ( | SdfPath const & | root | ) |
Returns the subtree rooted under the given path.
HD_API bool GetSceneDelegateAndInstancerIds | ( | SdfPath const & | id, |
SdfPath * | sceneDelegateId, | ||
SdfPath * | instancerId | ||
) | const |
Query function to return the id's of the scene delegate and instancer associated with the Rprim at the given path.
HD_API HdSceneDelegate* GetSceneDelegateForRprim | ( | SdfPath const & | id | ) | const |
Returns the scene delegate for the given rprim.
Returns the subtree rooted under the given path for the given sprim type.
HD_API HdTaskSharedPtr const& GetTask | ( | SdfPath const & | id | ) | const |
Returns the task for the given id
.
|
inline |
Returns true if instancer id
exists in index.
Definition at line 267 of file renderIndex.h.
|
inline |
Returns true if rprim id
exists in index.
Definition at line 215 of file renderIndex.h.
|
inline |
Returns true if a task exists in the index with the given id
.
Definition at line 288 of file renderIndex.h.
HD_API void InsertBprim | ( | TfToken const & | typeId, |
HdSceneDelegate * | delegate, | ||
SdfPath const & | bprimId | ||
) |
Insert a bprim into index.
HD_API void InsertInstancer | ( | HdSceneDelegate * | delegate, |
SdfPath const & | id | ||
) |
Insert an instancer into index.
HD_API void InsertRprim | ( | TfToken const & | typeId, |
HdSceneDelegate * | sceneDelegate, | ||
SdfPath const & | rprimId | ||
) |
Insert a rprim into index.
HD_API void InsertSprim | ( | TfToken const & | typeId, |
HdSceneDelegate * | delegate, | ||
SdfPath const & | sprimId | ||
) |
Insert a sprim into index.
void InsertTask | ( | HdSceneDelegate * | delegate, |
SdfPath const & | id | ||
) |
Inserts a new task into the render index with an identifier of id
.
Definition at line 519 of file renderIndex.h.
HD_API bool IsBprimTypeSupported | ( | TfToken const & | typeId | ) | const |
Returns whether the bprim type is supported by this render index.
HD_API bool IsRprimTypeSupported | ( | TfToken const & | typeId | ) | const |
Returns whether the rprim type is supported by this render index.
HD_API bool IsSprimTypeSupported | ( | TfToken const & | typeId | ) | const |
Returns whether the sprim type is supported by this render index.
|
static |
HD_API void RemoveInstancer | ( | SdfPath const & | id | ) |
Remove an instancer from index.
HD_API void RemoveRprim | ( | SdfPath const & | id | ) |
Remove a rprim from index.
HD_API void RemoveSubtree | ( | const SdfPath & | root, |
HdSceneDelegate * | sceneDelegate | ||
) |
Clear all entries in the render index under the given root and belong to a specified delegate.
Used for example to unload a delegate.
HD_API void RemoveTask | ( | SdfPath const & | id | ) |
Removes the given task from the RenderIndex.
HD_API void SyncAll | ( | HdTaskSharedPtrVector * | tasks, |
HdTaskContext * | taskContext | ||
) |
Syncs input tasks, B & S prims, (external) computations and processes all pending dirty lists (which syncs the R prims).
At the end of this step, all the resources that need to be updated have handles to their data sources. This is the first phase in Hydra's execution. See HdEngine::Execute