HdEmbreeRendererPlugin Class Reference

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

#include <rendererPlugin.h>

Inheritance diagram for HdEmbreeRendererPlugin:

Public Member Functions
HdRenderDelegate *	CreateRenderDelegate () override
	Construct a new render delegate of type HdEmbreeRenderDelegate.
HdRenderDelegate *	CreateRenderDelegate (HdRenderSettingsMap const &settingsMap) override
	Construct a new render delegate of type HdEmbreeRenderDelegate.
void	DeleteRenderDelegate (HdRenderDelegate *renderDelegate) override
	Destroy a render delegate created by this class's CreateRenderDelegate.
bool	IsSupported (bool gpuEnabled=true) const override
	Checks to see if the embree plugin is supported on the running system.
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.
HD_API TfToken	GetPluginId () const
	Look-up plugin id in plugin registry.
virtual HdRenderDelegate *	CreateRenderDelegate ()=0
	Clients should use CreateDelegate since this method will eventually become protected, use CreateRenderDelegateHandle instead.
virtual HD_API HdRenderDelegate *	CreateRenderDelegate (HdRenderSettingsMap const &settingsMap)
	Clients should use CreateDelegate since this method will eventually become protected.
virtual void	DeleteRenderDelegate (HdRenderDelegate *renderDelegate)=0
	Clients should use CreateDelegate since this method will eventually become protected.
virtual bool	IsSupported (bool gpuEnabled=true) const =0
	Returns true if this renderer plugin is supported in the running process and false if not.

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

CreateRenderDelegate() [1/2]

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.

CreateRenderDelegate() [2/2]

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

settingsMap

A list of initialization-time settings for embree.

Returns

A new HdEmbreeRenderDelegate object.

Reimplemented from HdRendererPlugin.

DeleteRenderDelegate()

void DeleteRenderDelegate ( HdRenderDelegate *  renderDelegate )

overridevirtual

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

Parameters

renderDelegate

The render delegate to delete.

Implements HdRendererPlugin.

IsSupported()

bool IsSupported ( bool  gpuEnabled = true ) 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:

• pxr/imaging/hdEmbree/rendererPlugin.h