HdPluginRendererUniqueHandle Class Reference

#include <pluginRendererUniqueHandle.h>

Public Member Functions
HD_API	HdPluginRendererUniqueHandle ()
HD_API	HdPluginRendererUniqueHandle (HdPluginRendererUniqueHandle &&)
HD_API	HdPluginRendererUniqueHandle (const std::nullptr_t &)
HD_API	~HdPluginRendererUniqueHandle ()
HD_API HdPluginRendererUniqueHandle &	operator= (HdPluginRendererUniqueHandle &&)
HD_API HdPluginRendererUniqueHandle &	operator= (const std::nullptr_t &)
HdRenderer *	Get () const
HdRenderer *	operator-> () const
HdRenderer &	operator* () const
	operator bool () const
	Is the wrapped HdRenderer valid? More...
HD_API TfToken	GetPluginId () const
	Id of the plugin used to create the renderer. More...

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.

Constructor & Destructor Documentation

HD_API HdPluginRendererUniqueHandle::HdPluginRendererUniqueHandle

(

)

HD_API HdPluginRendererUniqueHandle::HdPluginRendererUniqueHandle

(

HdPluginRendererUniqueHandle &&

)

HD_API HdPluginRendererUniqueHandle::HdPluginRendererUniqueHandle

(

const std::nullptr_t &

)

HD_API HdPluginRendererUniqueHandle::~HdPluginRendererUniqueHandle

(

)

Member Function Documentation

HdRenderer* HdPluginRendererUniqueHandle::Get ( ) const

inline

Definition at line 49 of file pluginRendererUniqueHandle.h.

HD_API TfToken HdPluginRendererUniqueHandle::GetPluginId

(

)

const

Id of the plugin used to create the renderer.

HdPluginRendererUniqueHandle::operator bool ( ) const

inlineexplicit

Is the wrapped HdRenderer valid?

Definition at line 55 of file pluginRendererUniqueHandle.h.

HdRenderer& HdPluginRendererUniqueHandle::operator* ( ) const

inline

Definition at line 52 of file pluginRendererUniqueHandle.h.

HdRenderer* HdPluginRendererUniqueHandle::operator-> ( ) const

inline

Definition at line 51 of file pluginRendererUniqueHandle.h.

HD_API HdPluginRendererUniqueHandle& HdPluginRendererUniqueHandle::operator=

(

HdPluginRendererUniqueHandle &&

)

HD_API HdPluginRendererUniqueHandle& HdPluginRendererUniqueHandle::operator=

(

const std::nullptr_t &

)

Friends And Related Function Documentation

friend class HdRendererPlugin

friend

Definition at line 62 of file pluginRendererUniqueHandle.h.

---

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

• pxr/imaging/hd/pluginRendererUniqueHandle.h