Inherits HdRenderDelegate.
Public Member Functions | |
HDST_API | HdStRenderDelegate (HdRenderSettingsMap const &settingsMap) |
HdRenderDelegate virtual API | |
virtual HDST_API void | SetDrivers (HdDriverVector const &drivers) override |
virtual HDST_API HdRenderParam * | GetRenderParam () 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 HdInstancer * | CreateInstancer (HdSceneDelegate *delegate, SdfPath const &id) override |
virtual HDST_API void | DestroyInstancer (HdInstancer *instancer) override |
virtual HDST_API HdRprim * | CreateRprim (TfToken const &typeId, SdfPath const &rprimId) override |
virtual HDST_API void | DestroyRprim (HdRprim *rPrim) override |
virtual HDST_API HdSprim * | CreateSprim (TfToken const &typeId, SdfPath const &sprimId) override |
virtual HDST_API HdSprim * | CreateFallbackSprim (TfToken const &typeId) override |
virtual HDST_API void | DestroySprim (HdSprim *sPrim) override |
virtual HDST_API HdBprim * | CreateBprim (TfToken const &typeId, SdfPath const &bprimId) override |
virtual HDST_API HdBprim * | CreateFallbackBprim (TfToken const &typeId) override |
virtual HDST_API void | DestroyBprim (HdBprim *bPrim) override |
virtual HDST_API void | CommitResources (HdChangeTracker *tracker) override |
virtual HDST_API TfTokenVector | GetMaterialRenderContexts () 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 |
Public Member Functions inherited from HdRenderDelegate | |
virtual HD_API void | SetDrivers (HdDriverVector const &drivers) |
Set list of driver objects, such as a rendering context / devices. More... | |
virtual const TfTokenVector & | GetSupportedRprimTypes () const =0 |
Returns a list of typeId's of all supported Rprims by this render delegate. More... | |
virtual const TfTokenVector & | GetSupportedSprimTypes () const =0 |
Returns a list of typeId's of all supported Sprims by this render delegate. More... | |
virtual const TfTokenVector & | GetSupportedBprimTypes () const =0 |
Returns a list of typeId's of all supported Bprims by this render delegate. More... | |
virtual HD_API HdRenderParam * | GetRenderParam () const |
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 > | |
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 HD_API bool | IsStopSupported () const |
Advertise whether this delegate supports stopping and restarting of background render threads. More... | |
virtual HD_API bool | Stop () |
Stop all of this delegate's background rendering threads. More... | |
virtual HD_API bool | Restart () |
Restart all of this delegate's background rendering threads previously stopped by a call to Stop. 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 HdInstancer * | CreateInstancer (HdSceneDelegate *delegate, SdfPath const &id)=0 |
Instancer Factory. More... | |
virtual void | DestroyInstancer (HdInstancer *instancer)=0 |
virtual HdRprim * | CreateRprim (TfToken const &typeId, SdfPath const &rprimId)=0 |
Prim Factories. More... | |
virtual void | DestroyRprim (HdRprim *rPrim)=0 |
Request to Destruct and deallocate the prim. More... | |
virtual HdSprim * | CreateSprim (TfToken const &typeId, SdfPath const &sprimId)=0 |
Request to Allocate and Construct a new Sprim. More... | |
virtual HdSprim * | CreateFallbackSprim (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 HdBprim * | CreateBprim (TfToken const &typeId, SdfPath const &bprimId)=0 |
Request to Allocate and Construct a new Bprim. More... | |
virtual HdBprim * | CreateFallbackBprim (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 |
virtual HD_API TfTokenVector | GetMaterialRenderContexts () const |
Returns a list, in descending order of preference, 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... | |
virtual HD_API HdCommandDescriptors | GetCommandDescriptors () const |
Commands API. More... | |
virtual HD_API bool | InvokeCommand (const TfToken &command, const HdCommandArgs &args=HdCommandArgs()) |
Invokes the command described by the token command with optional args . More... | |
Misc public API | |
HDST_API Hgi * | GetHgi () |
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 |
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 48 of file renderDelegate.h.