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

#include <unitTestNullRenderDelegate.h>

+ Inheritance diagram for Hd_UnitTestNullRenderDelegate:

Public Member Functions

 Hd_UnitTestNullRenderDelegate ()=default
 
 ~Hd_UnitTestNullRenderDelegate () override=default
 
HD_API const TfTokenVector & GetSupportedRprimTypes () const override
 
HD_API const TfTokenVector & GetSupportedSprimTypes () const override
 
HD_API const TfTokenVector & GetSupportedBprimTypes () const override
 
HD_API HdRenderParam * GetRenderParam () const override
 
HD_API HdResourceRegistrySharedPtr GetResourceRegistry () const override
 
HD_API HdRenderPassSharedPtr CreateRenderPass (HdRenderIndex *index, HdRprimCollection const &collection) override
 
HD_API HdInstancer * CreateInstancer (HdSceneDelegate *delegate, SdfPath const &id) override
 
HD_API void DestroyInstancer (HdInstancer *instancer) override
 
HD_API HdRprim * CreateRprim (TfToken const &typeId, SdfPath const &rprimId) override
 
HD_API void DestroyRprim (HdRprim *rPrim) override
 
HD_API HdSprim * CreateSprim (TfToken const &typeId, SdfPath const &sprimId) override
 
HD_API HdSprim * CreateFallbackSprim (TfToken const &typeId) override
 
HD_API void DestroySprim (HdSprim *sprim) override
 
HD_API HdBprim * CreateBprim (TfToken const &typeId, SdfPath const &bprimId) override
 
HD_API HdBprim * CreateFallbackBprim (TfToken const &typeId) override
 
HD_API void DestroyBprim (HdBprim *bprim) override
 
HD_API void CommitResources (HdChangeTracker *tracker) override
 
HD_API HdCommandDescriptors GetCommandDescriptors () const override
 
HD_API bool InvokeCommand (const TfToken &command, const HdCommandArgs &args=HdCommandArgs()) override
 
- Public Member Functions inherited from HdRenderDelegate
virtual HD_API ~HdRenderDelegate ()
 
virtual HD_API void SetDrivers (HdDriverVector const &drivers)
 
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
HdRenderSettingDescriptorList 		GetRenderSettingDescriptors () const
 
virtual HD_API unsigned int GetRenderSettingsVersion () const
 
virtual HD_API VtDictionary GetRenderStats () 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
HdRenderPassStateSharedPtr 		CreateRenderPassState () const
 
virtual HD_API TfToken GetMaterialBindingPurpose () const
 
virtual HD_API TfToken GetMaterialNetworkSelector () const
 
virtual HD_API TfTokenVector GetMaterialRenderContexts () const
 
virtual HD_API TfTokenVector GetRenderSettingsNamespaces () const
 
virtual HD_API bool IsPrimvarFilteringNeeded () const
 
virtual HD_API TfTokenVector GetShaderSourceTypes () const
 
virtual HD_API HdAovDescriptor GetDefaultAovDescriptor (TfToken const &name) const
 
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
 

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

Definition at line 16 of file unitTestNullRenderDelegate.h.

Constructor & Destructor Documentation

Hd_UnitTestNullRenderDelegate::Hd_UnitTestNullRenderDelegate ( )
default
Hd_UnitTestNullRenderDelegate::~Hd_UnitTestNullRenderDelegate ( )
overridedefault

Member Function Documentation

HD_API void Hd_UnitTestNullRenderDelegate::CommitResources ( HdChangeTracker *  tracker)
overridevirtual

Sync, Execute & Dispatch Hooks

Implements HdRenderDelegate.

HD_API HdBprim* Hd_UnitTestNullRenderDelegate::CreateBprim ( TfToken const &  typeId,
SdfPath const &  bprimId 
)
overridevirtual

Request to Allocate and Construct a new Bprim.

Parameters
typeIdthe type identifier of the prim to allocate
sprimIda unique identifier for the prim
Returns
A pointer to the new prim or nullptr on error.

Implements HdRenderDelegate.

HD_API HdBprim* Hd_UnitTestNullRenderDelegate::CreateFallbackBprim ( TfToken const &  typeId)
overridevirtual

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. For example, if another prim references a non-exisiting Bprim, the fallback could be used.

Parameters
typeIdthe type identifier of the prim to allocate
Returns
A pointer to the new prim or nullptr on error.

Implements HdRenderDelegate.

HD_API HdSprim* Hd_UnitTestNullRenderDelegate::CreateFallbackSprim ( TfToken const &  typeId)
overridevirtual

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. For example, if another prim references a non-exisiting Sprim, the fallback could be used.

Parameters
typeIdthe type identifier of the prim to allocate
Returns
A pointer to the new prim or nullptr on error.

Implements HdRenderDelegate.

HD_API HdInstancer* Hd_UnitTestNullRenderDelegate::CreateInstancer ( HdSceneDelegate *  delegate,
SdfPath const &  id 
)
overridevirtual

Instancer Factory

Implements HdRenderDelegate.

HD_API HdRenderPassSharedPtr Hd_UnitTestNullRenderDelegate::CreateRenderPass ( HdRenderIndex *  index,
HdRprimCollection const &  collection 
)
overridevirtual

Renderpass factory

Implements HdRenderDelegate.

HD_API HdRprim* Hd_UnitTestNullRenderDelegate::CreateRprim ( TfToken const &  typeId,
SdfPath const &  rprimId 
)
overridevirtual

Prim Factories

Implements HdRenderDelegate.

HD_API HdSprim* Hd_UnitTestNullRenderDelegate::CreateSprim ( TfToken const &  typeId,
SdfPath const &  sprimId 
)
overridevirtual

Request to Allocate and Construct a new Sprim.

Parameters
typeIdthe type identifier of the prim to allocate
sprimIda unique identifier for the prim
Returns
A pointer to the new prim or nullptr on error.

Implements HdRenderDelegate.

HD_API void Hd_UnitTestNullRenderDelegate::DestroyBprim ( HdBprim *  bprim)
overridevirtual

Request to Destruct and deallocate the prim.

Implements HdRenderDelegate.

HD_API void Hd_UnitTestNullRenderDelegate::DestroyInstancer ( HdInstancer *  instancer)
overridevirtual

Implements HdRenderDelegate.

HD_API void Hd_UnitTestNullRenderDelegate::DestroyRprim ( HdRprim *  rPrim)
overridevirtual

Request to Destruct and deallocate the prim.

Implements HdRenderDelegate.

HD_API void Hd_UnitTestNullRenderDelegate::DestroySprim ( HdSprim *  sprim)
overridevirtual

Request to Destruct and deallocate the prim.

Implements HdRenderDelegate.

HD_API HdCommandDescriptors Hd_UnitTestNullRenderDelegate::GetCommandDescriptors ( ) const
overridevirtual

Commands API

Reimplemented from HdRenderDelegate.

HD_API HdRenderParam* Hd_UnitTestNullRenderDelegate::GetRenderParam ( ) const
overridevirtual

Returns an opaque handle to a render param, that in turn is passed to each prim created by the render delegate during sync processing. This avoids the need to store a global state pointer in each prim.

The typical lifetime of the renderParam would match that of the RenderDelegate, however the minimal lifetime is that of the Sync processing. The param maybe queried multiple times during sync.

A render delegate may return null for the param.

Reimplemented from HdRenderDelegate.

HD_API HdResourceRegistrySharedPtr Hd_UnitTestNullRenderDelegate::GetResourceRegistry ( ) const
overridevirtual

Returns a shared ptr to the resource registry of the current render delegate.

Implements HdRenderDelegate.

HD_API const TfTokenVector& Hd_UnitTestNullRenderDelegate::GetSupportedBprimTypes ( ) const
overridevirtual

Returns a list of typeId's of all supported Bprims by this render delegate.

Implements HdRenderDelegate.

HD_API const TfTokenVector& Hd_UnitTestNullRenderDelegate::GetSupportedRprimTypes ( ) const
overridevirtual

Returns a list of typeId's of all supported Rprims by this render delegate.

Implements HdRenderDelegate.

HD_API const TfTokenVector& Hd_UnitTestNullRenderDelegate::GetSupportedSprimTypes ( ) const
overridevirtual

Returns a list of typeId's of all supported Sprims by this render delegate.

Implements HdRenderDelegate.

HD_API bool Hd_UnitTestNullRenderDelegate::InvokeCommand ( const TfToken &  command,
const HdCommandArgs &  args = HdCommandArgs() 
)
overridevirtual

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().

Reimplemented from HdRenderDelegate.

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