HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
HdRendererPlugin Class Referenceabstract

#include <rendererPlugin.h>

+ Inheritance diagram for HdRendererPlugin:

Public Member Functions

HD_API
HdPluginRenderDelegateUniqueHandle 		CreateDelegate (HdRenderSettingsMap const &settingsMap={})
 
HD_API TfToken GetPluginId () const
 
virtual HdRenderDelegate * CreateRenderDelegate ()=0
 
virtual HD_API HdRenderDelegate * CreateRenderDelegate (HdRenderSettingsMap const &settingsMap)
 
virtual void DeleteRenderDelegate (HdRenderDelegate *renderDelegate)=0
 
virtual bool IsSupported (bool gpuEnabled=true) const =0
 
- Public Member Functions inherited from HfPluginBase
virtual HF_API ~HfPluginBase ()
 

Protected Member Functions

 HdRendererPlugin ()=default
 
HD_API ~HdRendererPlugin () override
 
- Protected Member Functions inherited from HfPluginBase
HF_API HfPluginBase ()=default
 

Detailed Description

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.

Constructor & Destructor Documentation

HdRendererPlugin::HdRendererPlugin ( )
protecteddefault
HD_API HdRendererPlugin::~HdRendererPlugin ( )
overrideprotected

Member Function Documentation

HD_API HdPluginRenderDelegateUniqueHandle HdRendererPlugin::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.

virtual HdRenderDelegate* HdRendererPlugin::CreateRenderDelegate ( )
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 HdStormRendererPlugin.

virtual HD_API HdRenderDelegate* HdRendererPlugin::CreateRenderDelegate ( HdRenderSettingsMap const &  settingsMap)
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 HdStormRendererPlugin.

virtual void HdRendererPlugin::DeleteRenderDelegate ( HdRenderDelegate *  renderDelegate)
pure virtual

Clients should use CreateDelegate since this method will eventually become protected.

Release the object factoried by CreateRenderDelegate().

Implemented in HdStormRendererPlugin.

HD_API TfToken HdRendererPlugin::GetPluginId ( ) const

Look-up plugin id in plugin registry.

virtual bool HdRendererPlugin::IsSupported ( bool  gpuEnabled = true) const
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. The gpuEnabled parameter indicates if the GPU is available for use by the plugin in case this information is necessary to make this determination.

Implemented in HdStormRendererPlugin.

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