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

#include <renderDelegate.h>

+ Inheritance diagram for HdStRenderDelegate:

Public Member Functions

HDST_API HdStRenderDelegate ()
 
HDST_API HdStRenderDelegate (HdRenderSettingsMap const &settingsMap)
 
HDST_API ~HdStRenderDelegate () override
 
HdRenderDelegate virtual API
HDST_API void SetDrivers (HdDriverVector const &drivers) override
 
HDST_API HdRenderParam * GetRenderParam () const override
 
HDST_API const TfTokenVector & GetSupportedRprimTypes () const override
 
HDST_API const TfTokenVector & GetSupportedSprimTypes () const override
 
HDST_API const TfTokenVector & GetSupportedBprimTypes () const override
 
HDST_API
HdResourceRegistrySharedPtr 		GetResourceRegistry () const override
 
HDST_API HdRenderPassSharedPtr CreateRenderPass (HdRenderIndex *index, HdRprimCollection const &collection) override
 
HDST_API HdRenderPassStateSharedPtr CreateRenderPassState () const override
 
HDST_API HdInstancer * CreateInstancer (HdSceneDelegate *delegate, SdfPath const &id) override
 
HDST_API void DestroyInstancer (HdInstancer *instancer) override
 
HDST_API HdRprim * CreateRprim (TfToken const &typeId, SdfPath const &rprimId) override
 
HDST_API void DestroyRprim (HdRprim *rPrim) override
 
HDST_API HdSprim * CreateSprim (TfToken const &typeId, SdfPath const &sprimId) override
 
HDST_API HdSprim * CreateFallbackSprim (TfToken const &typeId) override
 
HDST_API void DestroySprim (HdSprim *sPrim) override
 
HDST_API HdBprim * CreateBprim (TfToken const &typeId, SdfPath const &bprimId) override
 
HDST_API HdBprim * CreateFallbackBprim (TfToken const &typeId) override
 
HDST_API void DestroyBprim (HdBprim *bPrim) override
 
HDST_API void CommitResources (HdChangeTracker *tracker) override
 
HDST_API TfTokenVector GetMaterialRenderContexts () const override
 
HDST_API TfTokenVector GetShaderSourceTypes () const override
 
HDST_API bool IsPrimvarFilteringNeeded () const override
 
HDST_API
HdRenderSettingDescriptorList 		GetRenderSettingDescriptors () const override
 
HDST_API VtDictionary GetRenderStats () const override
 
HDST_API HdAovDescriptor GetDefaultAovDescriptor (TfToken const &name) const override
 
HDST_API bool RequiresStormTasks () const override
 
- Public Member Functions inherited from HdRenderDelegate
virtual HD_API ~HdRenderDelegate ()
 
virtual HD_API void SetRenderSetting (TfToken const &key, VtValue const &value)
 
virtual HD_API VtValue GetRenderSetting (TfToken const &key) const
 
template<typename T >
T GetRenderSetting (TfToken const &key, T const &defValue) const
 
virtual HD_API unsigned int GetRenderSettingsVersion () const
 
virtual HD_API
HdContainerDataSourceHandle 		GetCapabilities () const
 
virtual HD_API bool IsPauseSupported () const
 
virtual HD_API bool IsPaused () const
 
virtual HD_API bool Pause ()
 
virtual HD_API bool Resume ()
 
virtual HD_API bool IsStopSupported () const
 
virtual HD_API bool IsStopped () const
 
virtual HD_API bool Stop (bool blocking=true)
 
virtual HD_API bool Restart ()
 
virtual HD_API TfToken GetMaterialBindingPurpose () const
 
virtual HD_API TfToken GetMaterialNetworkSelector () const
 
virtual HD_API TfTokenVector GetRenderSettingsNamespaces () const
 
virtual HD_API TfTokenVector GetShadingSystems () const
 
virtual HD_API HdCommandDescriptors GetCommandDescriptors () const
 
virtual HD_API bool InvokeCommand (const TfToken &command, const HdCommandArgs &args=HdCommandArgs())
 
HD_API const std::string & GetRendererDisplayName ()
 Populated when instantiated via the HdRendererPluginRegistry. More...
 
virtual HD_API void SetTerminalSceneIndex (const HdSceneIndexBaseRefPtr &terminalSceneIndex)
 
virtual HD_API void Update ()
 
virtual HD_API bool IsParallelSyncEnabled (const TfToken &primType) const
 

Misc public API

HDST_API HdStDrawItemsCachePtr GetDrawItemsCache () const
 
HDST_API Hgi * GetHgi ()
 
static HDST_API bool IsSupported (HdRendererCreateArgs const &rendererCreateArgs={})
 
static HDST_API const
HdRenderDelegateInfo & 		GetRenderDelegateInfo ()
 

Additional Inherited Members

- Protected Member Functions inherited from HdRenderDelegate
HD_API HdRenderDelegate ()
 This class must be derived from. More...
 
HD_API HdRenderDelegate (HdRenderSettingsMap const &settingsMap)
 Allow derived classes to pass construction-time render settings. More...
 
 HdRenderDelegate (const HdRenderDelegate &)=delete
 
HdRenderDelegate & operator= (const HdRenderDelegate &)=delete
 
HD_API void _PopulateDefaultSettings (HdRenderSettingDescriptorList const &defaultSettings)
 
- Protected Attributes inherited from HdRenderDelegate
HdRenderSettingsMap _settingsMap
 Render settings state. More...
 
unsigned int _settingsVersion
 

Detailed Description

HdStRenderDelegate

The Storm Render Delegate provides a rasterizer renderer to draw the scene. While it currently has some ties to GL, the goal is to use Hgi to allow it to be graphics API agnostic.

Definition at line 36 of file renderDelegate.h.

Constructor & Destructor Documentation

HDST_API HdStRenderDelegate::HdStRenderDelegate ( )
HDST_API HdStRenderDelegate::HdStRenderDelegate ( HdRenderSettingsMap const &  settingsMap)
HDST_API HdStRenderDelegate::~HdStRenderDelegate ( )
override

Member Function Documentation

HDST_API void HdStRenderDelegate::CommitResources ( HdChangeTracker *  tracker)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdBprim* HdStRenderDelegate::CreateBprim ( TfToken const &  typeId,
SdfPath const &  bprimId 
)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdBprim* HdStRenderDelegate::CreateFallbackBprim ( TfToken const &  typeId)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdSprim* HdStRenderDelegate::CreateFallbackSprim ( TfToken const &  typeId)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdInstancer* HdStRenderDelegate::CreateInstancer ( HdSceneDelegate *  delegate,
SdfPath const &  id 
)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdRenderPassSharedPtr HdStRenderDelegate::CreateRenderPass ( HdRenderIndex *  index,
HdRprimCollection const &  collection 
)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdRenderPassStateSharedPtr HdStRenderDelegate::CreateRenderPassState ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

HDST_API HdRprim* HdStRenderDelegate::CreateRprim ( TfToken const &  typeId,
SdfPath const &  rprimId 
)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdSprim* HdStRenderDelegate::CreateSprim ( TfToken const &  typeId,
SdfPath const &  sprimId 
)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API void HdStRenderDelegate::DestroyBprim ( HdBprim *  bPrim)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API void HdStRenderDelegate::DestroyInstancer ( HdInstancer *  instancer)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API void HdStRenderDelegate::DestroyRprim ( HdRprim *  rPrim)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API void HdStRenderDelegate::DestroySprim ( HdSprim *  sPrim)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API HdAovDescriptor HdStRenderDelegate::GetDefaultAovDescriptor ( TfToken const &  name) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

HDST_API HdStDrawItemsCachePtr HdStRenderDelegate::GetDrawItemsCache ( ) const
HDST_API Hgi* HdStRenderDelegate::GetHgi ( )
HDST_API TfTokenVector HdStRenderDelegate::GetMaterialRenderContexts ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

static HDST_API const HdRenderDelegateInfo& HdStRenderDelegate::GetRenderDelegateInfo ( )
static
HDST_API HdRenderParam* HdStRenderDelegate::GetRenderParam ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

HDST_API HdRenderSettingDescriptorList HdStRenderDelegate::GetRenderSettingDescriptors ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

HDST_API VtDictionary HdStRenderDelegate::GetRenderStats ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

HDST_API HdResourceRegistrySharedPtr HdStRenderDelegate::GetResourceRegistry ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API TfTokenVector HdStRenderDelegate::GetShaderSourceTypes ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

HDST_API const TfTokenVector& HdStRenderDelegate::GetSupportedBprimTypes ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API const TfTokenVector& HdStRenderDelegate::GetSupportedRprimTypes ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API const TfTokenVector& HdStRenderDelegate::GetSupportedSprimTypes ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Implements HdRenderDelegate.

HDST_API bool HdStRenderDelegate::IsPrimvarFilteringNeeded ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

static HDST_API bool HdStRenderDelegate::IsSupported ( HdRendererCreateArgs const &  rendererCreateArgs = {})
static
HDST_API bool HdStRenderDelegate::RequiresStormTasks ( ) const
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

HDST_API void HdStRenderDelegate::SetDrivers ( HdDriverVector const &  drivers)
overridevirtual

Flag for the HdxTaskControllerSceneIndex.

The HdxTaskControllerSceneIndex requires a different configuration for Storm than any other render delegate.

Reimplemented from HdRenderDelegate.

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