Loading...
Searching...
No Matches
HdPluginRendererUniqueHandle Class Referencefinal

A handle for a renderer that was created by a renderer plugin. More...

#include <pluginRendererUniqueHandle.h>

Public Member Functions

HD_API HdPluginRendererUniqueHandle (HdPluginRendererUniqueHandle &&)
 
HD_API HdPluginRendererUniqueHandle (const std::nullptr_t &)
 
HD_API HdPluginRendererUniqueHandleoperator= (HdPluginRendererUniqueHandle &&)
 
HD_API HdPluginRendererUniqueHandleoperator= (const std::nullptr_t &)
 
HdRendererGet () const
 
HdRendereroperator-> () const
 
HdRendereroperator* () const
 
 operator bool () const
 Is the wrapped HdRenderer valid?
 
HD_API TfToken GetPluginId () const
 Id of the plugin used to create the renderer.
 

Friends

class HdRendererPlugin
 

Detailed Description

A handle for a renderer that was created by a renderer plugin.

Its semantics are similar to std::unique_ptr.

The handle owns the renderer and ensures that the plugin is kept alive until the renderer is destroyed. The handle can also be queried for the id of the plugin used to create the renderer.

Definition at line 28 of file pluginRendererUniqueHandle.h.

Member Function Documentation

◆ Get()

HdRenderer * Get ( ) const
inline

Definition at line 49 of file pluginRendererUniqueHandle.h.

◆ GetPluginId()

HD_API TfToken GetPluginId ( ) const

Id of the plugin used to create the renderer.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Is the wrapped HdRenderer valid?

Definition at line 55 of file pluginRendererUniqueHandle.h.

◆ operator*()

HdRenderer & operator* ( ) const
inline

Definition at line 52 of file pluginRendererUniqueHandle.h.

◆ operator->()

HdRenderer * operator-> ( ) const
inline

Definition at line 51 of file pluginRendererUniqueHandle.h.

Friends And Related Function Documentation

◆ HdRendererPlugin

friend class HdRendererPlugin
friend

Definition at line 62 of file pluginRendererUniqueHandle.h.


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