Registers debugging scene index if env var HDSI_DEBUGGING_SCENE_INDEX_INSERTION_PHASE is an integer. More...

Inheritance diagram for HdsiDebuggingSceneIndexPlugin:

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.

HDSI_API bool	_IsEnabled (const HdContainerDataSourceHandle &inputArgs) const override
	Subclasses implement this to indicate whether the plugin is enabled.

Protected Member Functions inherited from HdSceneIndexPlugin
virtual HD_API HdSceneIndexBaseRefPtr	_AppendSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const HdContainerDataSourceHandle &inputArgs)
	Subclasses implement this to instantiate one or more scene indicies which take the provided scene as input.

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.

virtual HD_API bool	_IsEnabled (const HdContainerDataSourceHandle &inputArgs) const
	Subclasses implement this to indicate whether the plugin is enabled.

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.

Detailed Description

Registers debugging scene index if env var HDSI_DEBUGGING_SCENE_INDEX_INSERTION_PHASE is an integer.

Member Function Documentation

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.

HDSI_API bool _IsEnabled ( const HdContainerDataSourceHandle & inputArgs ) const

overrideprotectedvirtual

Subclasses implement this to indicate whether the plugin is enabled.

This is preferable to using env guards to gate registration and scene index instatiation in _AppendSceneIndex.

Base implementation returns true.

Reimplemented from HdSceneIndexPlugin.

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