HdRendererPluginRegistry Class Reference

#include <rendererPluginRegistry.h>

Inheritance diagram for HdRendererPluginRegistry:

Public Member Functions
HD_API TfToken	GetDefaultPluginId (bool gpuEnabled=true)
HD_API HdRendererPlugin *	GetRendererPlugin (const TfToken &pluginId)
HD_API HdRendererPluginHandle	GetOrCreateRendererPlugin (const TfToken &pluginId)
HD_API HdPluginRenderDelegateUniqueHandle	CreateRenderDelegate (const TfToken &pluginId, const HdRenderSettingsMap &settingsMap={})
Public Member Functions inherited from HfPluginRegistry
HF_API void	GetPluginDescs (HfPluginDescVector *plugins)
HF_API bool	GetPluginDesc (const TfToken &pluginId, HfPluginDesc *desc)
HF_API void	AddPluginReference (HfPluginBase *plugin)
HF_API void	ReleasePlugin (HfPluginBase *plugin)
HF_API bool	IsRegisteredPlugin (const TfToken &pluginId)
HF_API TfToken	GetPluginId (const HfPluginBase *plugin) const

Static Public Member Functions
static HD_API HdRendererPluginRegistry &	GetInstance ()
template<typename T , typename... Bases>
static void	Define ()

Friends
class	TfSingleton< HdRendererPluginRegistry >

Additional Inherited Members
Protected Member Functions inherited from HfPluginRegistry
HF_API	HfPluginRegistry (const TfType &pluginBaseType)
virtual HF_API	~HfPluginRegistry ()
HF_API HfPluginBase *	GetPlugin (const TfToken &pluginId)
virtual HF_API void	_CollectAdditionalMetadata (const PlugRegistry &plugRegistry, const TfType &pluginType)
Static Protected Member Functions inherited from HfPluginRegistry
template<typename T , typename PluginBaseType , typename... Bases>
static void	Define ()

Detailed Description

Definition at line 40 of file rendererPluginRegistry.h.

Member Function Documentation

HD_API HdPluginRenderDelegateUniqueHandle HdRendererPluginRegistry::CreateRenderDelegate	(	const TfToken &	pluginId,
		const HdRenderSettingsMap &	settingsMap = {}
	)

Returns a render delegate created by the plugin with the given name if the plugin is supported using given initial settings. The render delegate is wrapped in a movable handle that keeps the plugin alive until the render delegate is destroyed by dropping the handle.

template<typename T , typename... Bases>

void HdRendererPluginRegistry::Define ( )

static

Entry point for defining an HdRendererPlugin plugin.

Definition at line 111 of file rendererPluginRegistry.h.

HD_API TfToken HdRendererPluginRegistry::GetDefaultPluginId

(

bool

gpuEnabled = true

)

Returns the id of plugin to use as the default. To ensure an appropriate default is found, the gpuEnabled parameter will be used to indicate if the GPU will be available when making the determination.

static HD_API HdRendererPluginRegistry& HdRendererPluginRegistry::GetInstance ( )

static

Returns the singleton registry for HdRendererPlugin

HD_API HdRendererPluginHandle HdRendererPluginRegistry::GetOrCreateRendererPlugin

(

const TfToken &

pluginId

)

Returns the renderer plugin for the given id or a null handle if not found. The plugin is wrapped in a handle that automatically increments and decrements the reference count and also stores the plugin id.

HD_API HdRendererPlugin* HdRendererPluginRegistry::GetRendererPlugin

(

const TfToken &

pluginId

)

Deprecated:

Use GetOrCreateRendererPlugin instead.

Returns the renderer plugin for the given id or null if not found. The reference count on the returned delegate is incremented.

Friends And Related Function Documentation

friend class TfSingleton< HdRendererPluginRegistry >

friend

Definition at line 96 of file rendererPluginRegistry.h.

---

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

• pxr/imaging/hd/rendererPluginRegistry.h