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

HdStRenderDelegate. More...

Inherits HdRenderDelegate.

Public Member Functions

HDST_API HdStRenderDelegate (HdRenderSettingsMap const &settingsMap)
 
virtual HDST_API HdRenderParamGetRenderParam () const override
 
virtual HDST_API const
TfTokenVector
GetSupportedRprimTypes () const override
 
virtual HDST_API const
TfTokenVector
GetSupportedSprimTypes () const override
 
virtual HDST_API const
TfTokenVector
GetSupportedBprimTypes () const override
 
virtual HDST_API
HdResourceRegistrySharedPtr 
GetResourceRegistry () const override
 
virtual HDST_API
HdRenderPassSharedPtr 
CreateRenderPass (HdRenderIndex *index, HdRprimCollection const &collection) override
 
virtual HDST_API
HdRenderPassStateSharedPtr 
CreateRenderPassState () const override
 
virtual HDST_API HdInstancerCreateInstancer (HdSceneDelegate *delegate, SdfPath const &id, SdfPath const &instancerId) override
 
virtual HDST_API void DestroyInstancer (HdInstancer *instancer) override
 
virtual HDST_API HdRprimCreateRprim (TfToken const &typeId, SdfPath const &rprimId, SdfPath const &instancerId) override
 
virtual HDST_API void DestroyRprim (HdRprim *rPrim) override
 
virtual HDST_API HdSprimCreateSprim (TfToken const &typeId, SdfPath const &sprimId) override
 
virtual HDST_API HdSprimCreateFallbackSprim (TfToken const &typeId) override
 
virtual HDST_API void DestroySprim (HdSprim *sPrim) override
 
virtual HDST_API HdBprimCreateBprim (TfToken const &typeId, SdfPath const &bprimId) override
 
virtual HDST_API HdBprimCreateFallbackBprim (TfToken const &typeId) override
 
virtual HDST_API void DestroyBprim (HdBprim *bPrim) override
 
virtual HDST_API void CommitResources (HdChangeTracker *tracker) override
 
virtual HDST_API TfToken GetMaterialNetworkSelector () const override
 
virtual HDST_API TfTokenVector GetShaderSourceTypes () const override
 
virtual HDST_API bool IsPrimvarFilteringNeeded () const override
 
virtual HDST_API
HdRenderSettingDescriptorList 
GetRenderSettingDescriptors () const override
 
virtual HDST_API VtDictionary GetRenderStats () const override
 
virtual HDST_API HdAovDescriptor GetDefaultAovDescriptor (TfToken const &name) const override
 
HDST_API HgiGetHgi ()
 
- Public Member Functions inherited from HdRenderDelegate
virtual const TfTokenVectorGetSupportedRprimTypes () const =0
 Returns a list of typeId's of all supported Rprims by this render delegate. More...
 
virtual const TfTokenVectorGetSupportedSprimTypes () const =0
 Returns a list of typeId's of all supported Sprims by this render delegate. More...
 
virtual const TfTokenVectorGetSupportedBprimTypes () const =0
 Returns a list of typeId's of all supported Bprims by this render delegate. More...
 
virtual HdRenderParamGetRenderParam () const =0
 Returns an opaque handle to a render param, that in turn is passed to each prim created by the render delegate during sync processing. More...
 
virtual HdResourceRegistrySharedPtr GetResourceRegistry () const =0
 Returns a shared ptr to the resource registry of the current render delegate. More...
 
virtual HD_API void SetRenderSetting (TfToken const &key, VtValue const &value)
 Set a custom render setting on this render delegate. More...
 
virtual HD_API VtValue GetRenderSetting (TfToken const &key) const
 Get the current value for a render setting. More...
 
template<typename T >
GetRenderSetting (TfToken const &key, T const &defValue) const
 Get the current value for a render setting, taking a desired type and a fallback value in case of type mismatch. More...
 
virtual HD_API
HdRenderSettingDescriptorList 
GetRenderSettingDescriptors () const
 Get the backend-exported render setting descriptors. More...
 
virtual HD_API unsigned int GetRenderSettingsVersion () const
 Get the current version of the render settings dictionary. More...
 
virtual HD_API VtDictionary GetRenderStats () const
 Returns an open-format dictionary of render statistics. More...
 
virtual HD_API bool IsPauseSupported () const
 Control of background rendering threads. More...
 
virtual HD_API bool Pause ()
 Pause all of this delegate's background rendering threads. More...
 
virtual HD_API bool Resume ()
 Resume all of this delegate's background rendering threads previously paused by a call to Pause. More...
 
virtual HdRenderPassSharedPtr CreateRenderPass (HdRenderIndex *index, HdRprimCollection const &collection)=0
 Renderpass Factory. More...
 
virtual HD_API
HdRenderPassStateSharedPtr 
CreateRenderPassState () const
 Request to create a new renderpass state. More...
 
virtual HdInstancerCreateInstancer (HdSceneDelegate *delegate, SdfPath const &id, SdfPath const &instancerId)=0
 Instancer Factory. More...
 
virtual void DestroyInstancer (HdInstancer *instancer)=0
 
virtual HdRprimCreateRprim (TfToken const &typeId, SdfPath const &rprimId, SdfPath const &instancerId)=0
 Prim Factories. More...
 
virtual void DestroyRprim (HdRprim *rPrim)=0
 Request to Destruct and deallocate the prim. More...
 
virtual HdSprimCreateSprim (TfToken const &typeId, SdfPath const &sprimId)=0
 Request to Allocate and Construct a new Sprim. More...
 
virtual HdSprimCreateFallbackSprim (TfToken const &typeId)=0
 Request to Allocate and Construct an Sprim to use as a standin, if there if an error with another another Sprim of the same type. More...
 
virtual void DestroySprim (HdSprim *sprim)=0
 Request to Destruct and deallocate the prim. More...
 
virtual HdBprimCreateBprim (TfToken const &typeId, SdfPath const &bprimId)=0
 Request to Allocate and Construct a new Bprim. More...
 
virtual HdBprimCreateFallbackBprim (TfToken const &typeId)=0
 Request to Allocate and Construct a Bprim to use as a standin, if there if an error with another another Bprim of the same type. More...
 
virtual void DestroyBprim (HdBprim *bprim)=0
 Request to Destruct and deallocate the prim. More...
 
virtual void CommitResources (HdChangeTracker *tracker)=0
 Sync, Execute & Dispatch Hooks. More...
 
virtual HD_API TfToken GetMaterialBindingPurpose () const
 Materials. More...
 
virtual HD_API TfToken GetMaterialNetworkSelector () const
 Returns a token that can be used to select among multiple material network implementations. More...
 
virtual HD_API bool IsPrimvarFilteringNeeded () const
 Return true to indicate that the render delegate wants rprim primvars to be filtered by the scene delegate to reduce the amount of primvars that are send to the render delegate. More...
 
virtual HD_API TfTokenVector GetShaderSourceTypes () const
 Returns the ordered list of shader source types that the render delegate supports. More...
 
virtual HD_API HdAovDescriptor GetDefaultAovDescriptor (TfToken const &name) const
 AOVs. More...
 

Static Public Member Functions

static HDST_API bool IsSupported ()
 

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
 This class is not intended to be copied. More...
 
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 Hydra render that uses a streaming graphics implementation to draw the scene.

Definition at line 44 of file renderDelegate.h.


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