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

#include <rendererPlugin.h>

+ Inheritance diagram for HdStormRendererPlugin:

Public Member Functions

 HdStormRendererPlugin ()=default
 
virtual ~HdStormRendererPlugin ()=default
 
HdRenderDelegate * CreateRenderDelegate () override
 
HdRenderDelegate * CreateRenderDelegate (HdRenderSettingsMap const &settingsMap) override
 
void DeleteRenderDelegate (HdRenderDelegate *renderDelegate) override
 
bool IsSupported (HdRendererCreateArgs const &rendererCreateArgs, std::string *reasonWhyNot=nullptr) const override
 
HdContainerDataSourceHandle GetSceneIndexInputArgs () const override
 
- Public Member Functions inherited from HdRendererPlugin
HD_API TfToken GetPluginId () const
 
HD_API std::string GetDisplayName () const
 
virtual HD_API bool IsSupported (bool gpuEnabled=true) const
 
virtual HD_API bool IsSupported (HdContainerDataSourceHandle const &rendererCreateArgs, std::string *reasonWhyNot=nullptr) const
 
HD_API HdPluginRendererUniqueHandle CreateRenderer (HdSceneIndexBaseRefPtr const &sceneIndex, HdContainerDataSourceHandle const &rendererCreateArgs)
 
HD_API
HdPluginRenderDelegateUniqueHandle 		CreateDelegate (HdRenderSettingsMap const &settingsMap={})
 
- Public Member Functions inherited from HfPluginBase
virtual HF_API ~HfPluginBase ()
 

Additional Inherited Members

- Protected Member Functions inherited from HdRendererPlugin
 HdRendererPlugin ()=default
 
HD_API ~HdRendererPlugin () override
 
virtual HD_API std::unique_ptr
< HdRenderer > 		_CreateRenderer (HdSceneIndexBaseRefPtr const &sceneIndex, HdContainerDataSourceHandle const &rendererCreateArgs)
 
HD_API std::unique_ptr
< HdRenderer > 		_CreateRendererFromRenderDelegate (HdSceneIndexBaseRefPtr const &sceneIndex, HdContainerDataSourceHandle const &rendererCreateArgs)
 
- Protected Member Functions inherited from HfPluginBase
HF_API HfPluginBase ()=default
 

Detailed Description

Definition at line 15 of file rendererPlugin.h.

Constructor & Destructor Documentation

HdStormRendererPlugin::HdStormRendererPlugin ( )
default
virtual HdStormRendererPlugin::~HdStormRendererPlugin ( )
virtualdefault

Member Function Documentation

HdRenderDelegate* HdStormRendererPlugin::CreateRenderDelegate ( )
overridevirtual

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.

Implements HdRendererPlugin.

HdRenderDelegate* HdStormRendererPlugin::CreateRenderDelegate ( HdRenderSettingsMap const &  settingsMap)
overridevirtual

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 from HdRendererPlugin.

void HdStormRendererPlugin::DeleteRenderDelegate ( HdRenderDelegate *  renderDelegate)
overridevirtual

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

Release the object factoried by CreateRenderDelegate().

Implements HdRendererPlugin.

HdContainerDataSourceHandle HdStormRendererPlugin::GetSceneIndexInputArgs ( ) const
overridevirtual

Arguments that an application should pass as input arguments to scene indices so that they can be configured for the needs of the renderer.

Follows the HdSceneIndexInputArgsSchema but can have data sources at additional data sources.

Example: Some scene indices are computing samples for motion blur non-lazy and need to know whether the renderer supports motion blur in advance.

Example: the configuration of the HdRenderIndexAdapterSceneIndex used by the legacy UsdImagingDelegate which needs the preference order of the material render contexts since it is resolving which material network to use rather than leaving it to a renderer- specific plugin scene index.

Reimplemented from HdRendererPlugin.

bool HdStormRendererPlugin::IsSupported ( HdRendererCreateArgs const &  rendererCreateArgs,
std::string *  reasonWhyNot = nullptr 
) const
overridevirtual

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 rendererCreateArgs parameter indicates the resources available when making this determination.

The reasonWhyNot param, when provided, can be filled with the reason why the renderer plugin is not supported.

Implements HdRendererPlugin.

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