HdPluginRenderDelegateUniqueHandle Class Reference

A (movable) handle for a render delegate that was created using a a plugin. More...

#include <pluginRenderDelegateUniqueHandle.h>

Public Member Functions
	HdPluginRenderDelegateUniqueHandle (const std::nullptr_t &)
HD_API	HdPluginRenderDelegateUniqueHandle (HdPluginRenderDelegateUniqueHandle &&)
	Transfer ownership.
HD_API HdPluginRenderDelegateUniqueHandle &	operator= (HdPluginRenderDelegateUniqueHandle &&)
	Transfer ownership.
HD_API HdPluginRenderDelegateUniqueHandle &	operator= (const std::nullptr_t &)
HdRenderDelegate *	Get () const
	Get render delegate.
HdRenderDelegate *	operator-> () const
HdRenderDelegate &	operator* () const
	operator bool () const
	Is the wrapped HdRenderDelegate valid?
HD_API TfToken	GetPluginId () const
	Get the id of the plugin used to create render delegate.

Friends
class	HdRendererPlugin

Detailed Description

A (movable) handle for a render delegate that was created using a a plugin.

The handle owns the render delegate (render delegate is destroyed when handle is dropped). The handle also can be queried what plugin was used to create the render delegate and ensures the plugin is kept alive until the render delegate is destroyed. In other words, the handle can be used just like a std::unique_ptr.

Definition at line 30 of file pluginRenderDelegateUniqueHandle.h.

Constructor & Destructor Documentation

HdPluginRenderDelegateUniqueHandle() [1/3]

HdPluginRenderDelegateUniqueHandle ( )

inline

Definition at line 33 of file pluginRenderDelegateUniqueHandle.h.

HdPluginRenderDelegateUniqueHandle() [2/3]

HdPluginRenderDelegateUniqueHandle ( const std::nullptr_t &  )

inline

Definition at line 34 of file pluginRenderDelegateUniqueHandle.h.

HdPluginRenderDelegateUniqueHandle() [3/3]

HD_API HdPluginRenderDelegateUniqueHandle

(

HdPluginRenderDelegateUniqueHandle &&

)

Transfer ownership.

Member Function Documentation

Get()

HdRenderDelegate * Get ( ) const

inline

Get render delegate.

Definition at line 54 of file pluginRenderDelegateUniqueHandle.h.

GetPluginId()

HD_API TfToken GetPluginId

(

)

const

Get the id of the plugin used to create render delegate.

operator bool()

operator bool ( ) const

inlineexplicit

Is the wrapped HdRenderDelegate valid?

Definition at line 60 of file pluginRenderDelegateUniqueHandle.h.

operator*()

HdRenderDelegate & operator* ( ) const

inline

Definition at line 57 of file pluginRenderDelegateUniqueHandle.h.

operator->()

HdRenderDelegate * operator-> ( ) const

inline

Definition at line 56 of file pluginRenderDelegateUniqueHandle.h.

operator=()

HD_API HdPluginRenderDelegateUniqueHandle & operator=

(

HdPluginRenderDelegateUniqueHandle &&

)

Transfer ownership.

Friends And Related Function Documentation

HdRendererPlugin

friend class HdRendererPlugin

friend

Definition at line 67 of file pluginRenderDelegateUniqueHandle.h.

---

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

• pxr/imaging/hd/pluginRenderDelegateUniqueHandle.h