HdsiPrimIdSceneIndexPlugin Class Reference

If the env var HDSI_ENABLE_PRIM_ID_SCENE_INDEX is true, appends an HdsiPrimIdSceneIndex as one of the last filtering scene indices for every renderer, so that prim ids are assigned to the final set of renderable prims. More...

Inheritance diagram for HdsiPrimIdSceneIndexPlugin:

Protected Member Functions
HDSI_API HdSceneIndexBaseRefPtr	_AppendSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs) override
	Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input. More...
Protected Member Functions inherited from HdSceneIndexPlugin
virtual HD_API HdSceneIndexBaseRefPtr	_AppendSceneIndex (const std::string &renderInstanceId, const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
	Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input. More...
virtual HD_API bool	_IsEnabled (const HdContainerDataSourceHandle &inputArgs) const
	Subclasses implement this to indicate whether the plugin is enabled. More...

Additional Inherited Members
Public Member Functions inherited from HdSceneIndexPlugin
HD_API HdSceneIndexBaseRefPtr	AppendSceneIndex (const std::string &renderInstanceId, const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
HD_API bool	IsEnabled (const HdContainerDataSourceHandle &inputArgs) const
	Returns true if the plugin is enabled, in the sense that it should be consulted for its contribution to the scene index chain via AppendSceneIndex. More...

Detailed Description

If the env var HDSI_ENABLE_PRIM_ID_SCENE_INDEX is true, appends an HdsiPrimIdSceneIndex as one of the last filtering scene indices for every renderer, so that prim ids are assigned to the final set of renderable prims.

Definition at line 23 of file primIdSceneIndexPlugin.h.

Member Function Documentation

_AppendSceneIndex()

HDSI_API HdSceneIndexBaseRefPtr _AppendSceneIndex ( const HdSceneIndexBaseRefPtr &  inputScene, const HdContainerDataSourceHandle &  inputArgs  )

overrideprotectedvirtual

Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input.

The return value should be the final scene created – or the inputScene itself if nothing is created.

Reimplemented from HdSceneIndexPlugin.

---

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

• pxr/imaging/hdsi/primIdSceneIndexPlugin.h