All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdRendererPlugin Class Referenceabstract

This class defines a renderer plugin interface for Hydra. More...

+ Inheritance diagram for HdRendererPlugin:

Public Member Functions

virtual HdRenderDelegate * CreateRenderDelegate ()=0
 Factory a Render Delegate object, that Hydra can use to factory prims and communicate with a renderer. More...
 
virtual HD_API HdRenderDelegate * CreateRenderDelegate (HdRenderSettingsMap const &settingsMap)
 Factory a Render Delegate object, that Hydra can use to factory prims and communicate with a renderer. More...
 
virtual void DeleteRenderDelegate (HdRenderDelegate *renderDelegate)=0
 Release the object factoried by CreateRenderDelegate(). More...
 
virtual bool IsSupported () const =0
 Returns true if this renderer plugin is supported in the running process and false if not. More...
 

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 48 of file rendererPlugin.h.

Member Function Documentation

virtual HdRenderDelegate* CreateRenderDelegate ( )
pure virtual

Factory a Render Delegate object, that Hydra can use to factory prims and communicate with a renderer.

Implemented in HdEmbreeRendererPlugin.

virtual HD_API HdRenderDelegate* CreateRenderDelegate ( HdRenderSettingsMap const &  settingsMap)
virtual

Factory a Render Delegate object, that Hydra can use to factory prims and communicate with a renderer.

Pass in initial settings...

Reimplemented in HdEmbreeRendererPlugin.

virtual void DeleteRenderDelegate ( HdRenderDelegate *  renderDelegate)
pure virtual

Release the object factoried by CreateRenderDelegate().

Implemented in HdEmbreeRendererPlugin.

virtual bool IsSupported ( ) 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.

Implemented in HdEmbreeRendererPlugin.


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