Loading...
Searching...
No Matches
List of all members
HdLegacyRenderControlInterface Class Referenceabstract

Transitory Hydra-1.0-like API for HdRenderer. More...

#include <legacyRenderControlInterface.h>

Public Member Functions

Task control
virtual void Execute (const SdfPathVector &taskPaths)=0
 
virtual bool AreTasksConverged (const SdfPathVector &taskPaths) const =0
 
virtual bool GetTaskContextData (const TfToken &name, VtValue *data) const =0
 
virtual void SetTaskContextData (const TfToken &name, const VtValue &data)=0
 
AOVs
virtual HdAovDescriptor GetDefaultAovDescriptor (const TfToken &name) const =0
 
virtual HdRenderBuffer * GetRenderBuffer (const SdfPath &path) const =0
 
Render settings
virtual HdRenderSettingDescriptorList GetRenderSettingDescriptors () const =0
 
virtual VtValue GetRenderSetting (const TfToken &name) const =0
 
virtual void SetRenderSetting (const TfToken &name, VtValue const &value)=0
 
Commands
virtual HdCommandDescriptors GetCommandDescriptors ()=0
 
virtual bool InvokeCommand (TfToken const &name, const HdCommandArgs &args={})=0
 Invokes the command described by the token command with optional args.
 
Background rendering control
virtual bool IsPauseSupported () const =0
 
virtual bool Pause ()=0
 
virtual bool Resume ()=0
 
virtual bool IsStopSupported () const =0
 
virtual bool Stop (bool blocking=true)=0
 
virtual bool Restart ()=0
 
Resolution information
virtual TfToken GetMaterialBindingPurpose () const =0
 
virtual TfTokenVector GetMaterialRenderContexts () const =0
 
virtual TfTokenVector GetRenderSettingsNamespaces () const =0
 
virtual bool IsPrimvarFilteringNeeded () const =0
 
virtual TfTokenVector GetShaderSourceTypes () const =0
 
virtual bool IsCoordSysSupported () const =0
 This is for UsdImagingDelegate::_coordSysEnabled that has a surprising performance impact.
 
HD_API HdRenderDelegateInfo GetRenderDelegateInfo () const
 
Misc
virtual bool RequiresStormTasks () const =0
 Provides value for HdxTaskControllerSceneIndex::Parameters::isForStorm to configure task controller scene inedx.
 
virtual VtDictionary GetRenderStats ()=0
 
virtual SdfPath GetRprimPathFromPrimId (int primIdx)=0
 

Detailed Description

Transitory Hydra-1.0-like API for HdRenderer.

Definition at line 32 of file legacyRenderControlInterface.h.

Member Function Documentation

◆ InvokeCommand()

virtual bool InvokeCommand ( TfToken const &  name,
const HdCommandArgs &  args = {} 
)
pure virtual

Invokes the command described by the token command with optional args.

If the command succeeds, returns true, otherwise returns false. A command will generally fail if it is not among those returned by GetCommandDescriptors().

◆ IsCoordSysSupported()

virtual bool IsCoordSysSupported ( ) const
pure virtual

This is for UsdImagingDelegate::_coordSysEnabled that has a surprising performance impact.

◆ RequiresStormTasks()

virtual bool RequiresStormTasks ( ) const
pure virtual

Provides value for HdxTaskControllerSceneIndex::Parameters::isForStorm to configure task controller scene inedx.

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