This class defines a renderer plugin interface for Hydra. More...
Public Member Functions | |
HD_API HdPluginRenderDelegateUniqueHandle | CreateDelegate (HdRenderSettingsMap const &settingsMap={}) |
Create a render delegate through the plugin and wrap it in a handle that keeps this plugin alive until render delegate is destroyed. More... | |
HD_API TfToken | GetPluginId () const |
Look-up plugin id in plugin registry. More... | |
virtual HdRenderDelegate * | CreateRenderDelegate ()=0 |
Clients should use CreateDelegate since this method will eventually become protected, use CreateRenderDelegateHandle instead. More... | |
virtual HD_API HdRenderDelegate * | CreateRenderDelegate (HdRenderSettingsMap const &settingsMap) |
Clients should use CreateDelegate since this method will eventually become protected. More... | |
virtual void | DeleteRenderDelegate (HdRenderDelegate *renderDelegate)=0 |
Clients should use CreateDelegate since this method will eventually become protected. More... | |
virtual bool | IsSupported () const =0 |
Returns true if this renderer plugin is supported in the running process and false if not. More... | |
This class defines a renderer plugin interface for Hydra.
A renderer plugin is a dynamically discovered and loaded at run-time using the Plug system.
This object has singleton behavior, in that is instantiated once per library (managed by the plugin registry).
The class is used to factory objects that provide delegate support to other parts of the Hydra Ecosystem.
Definition at line 49 of file rendererPlugin.h.
HD_API HdPluginRenderDelegateUniqueHandle CreateDelegate | ( | HdRenderSettingsMap const & | settingsMap = {} | ) |
Create a render delegate through the plugin and wrap it in a handle that keeps this plugin alive until render delegate is destroyed.
Initial settings can be passed in.
|
pure virtual |
Clients should use CreateDelegate since this method will eventually become protected, use CreateRenderDelegateHandle instead.
Factory a Render Delegate object, that Hydra can use to factory prims and communicate with a renderer.
Implemented in HdEmbreeRendererPlugin.
|
virtual |
Clients should use CreateDelegate since this method will eventually become protected.
Factory a Render Delegate object, that Hydra can use to factory prims and communicate with a renderer. Pass in initial settings...
Reimplemented in HdEmbreeRendererPlugin.
|
pure virtual |
Clients should use CreateDelegate since this method will eventually become protected.
Release the object factoried by CreateRenderDelegate().
Implemented in HdEmbreeRendererPlugin.
HD_API TfToken GetPluginId | ( | ) | const |
Look-up plugin id in plugin registry.
|
pure virtual |
Returns true
if this renderer plugin is supported in the running process and false
if not.
This gives the plugin a chance to perform some runtime checks to make sure that the system meets minimum requirements.
Implemented in HdEmbreeRendererPlugin.