All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdEmbreeRendererPlugin Class Referencefinal

A registered child of HdRendererPlugin, this is the class that gets loaded when a hydra application asks to draw with a certain renderer. More...

+ Inheritance diagram for HdEmbreeRendererPlugin:

Public Member Functions

virtual HdRenderDelegate * CreateRenderDelegate () override
 Construct a new render delegate of type HdEmbreeRenderDelegate. More...
 
virtual HdRenderDelegate * CreateRenderDelegate (HdRenderSettingsMap const &settingsMap) override
 Construct a new render delegate of type HdEmbreeRenderDelegate. More...
 
virtual void DeleteRenderDelegate (HdRenderDelegate *renderDelegate) override
 Destroy a render delegate created by this class's CreateRenderDelegate. More...
 
virtual bool IsSupported () const override
 Checks to see if the embree plugin is supported on the running system. More...
 
- Public Member Functions inherited from HdRendererPlugin
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...
 

Detailed Description

A registered child of HdRendererPlugin, this is the class that gets loaded when a hydra application asks to draw with a certain renderer.

It supports rendering via creation/destruction of renderer-specific classes. The render delegate is the hydra-facing entrypoint into the renderer; it's responsible for creating specialized implementations of hydra prims (which translate scene data into drawable representations) and hydra renderpasses (which draw the scene to the framebuffer).

Definition at line 43 of file rendererPlugin.h.

Member Function Documentation

virtual HdRenderDelegate* CreateRenderDelegate ( )
overridevirtual

Construct a new render delegate of type HdEmbreeRenderDelegate.

Embree render delegates own the embree scene object, so a new render delegate should be created for each instance of HdRenderIndex.

Returns
A new HdEmbreeRenderDelegate object.

Implements HdRendererPlugin.

virtual HdRenderDelegate* CreateRenderDelegate ( HdRenderSettingsMap const &  settingsMap)
overridevirtual

Construct a new render delegate of type HdEmbreeRenderDelegate.

Embree render delegates own the embree scene object, so a new render delegate should be created for each instance of HdRenderIndex.

Parameters
settingsMapA list of initialization-time settings for embree.
Returns
A new HdEmbreeRenderDelegate object.

Reimplemented from HdRendererPlugin.

virtual void DeleteRenderDelegate ( HdRenderDelegate *  renderDelegate)
overridevirtual

Destroy a render delegate created by this class's CreateRenderDelegate.

Parameters
renderDelegateThe render delegate to delete.

Implements HdRendererPlugin.

virtual bool IsSupported ( ) const
overridevirtual

Checks to see if the embree plugin is supported on the running system.

Implements HdRendererPlugin.


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