HdRendererPluginHandle Class Reference

A handle for HdRendererPlugin also storing the plugin id. More...

#include <rendererPluginHandle.h>

Public Member Functions
	HdRendererPluginHandle (const std::nullptr_t &)
HD_API	HdRendererPluginHandle (const HdRendererPluginHandle &)
HD_API	HdRendererPluginHandle (HdRendererPluginHandle &&)
HD_API HdRendererPluginHandle &	operator= (const HdRendererPluginHandle &)
HD_API HdRendererPluginHandle &	operator= (HdRendererPluginHandle &&)
HD_API HdRendererPluginHandle &	operator= (const std::nullptr_t &)
HdRendererPlugin *	Get () const
	Get the wrapped HdRendererPlugin.
HdRendererPlugin *	operator-> () const
HdRendererPlugin &	operator* () const
	operator bool () const
	Is the wrapped HdRendererPlugin valid?

Friends
class	HdRendererPluginRegistry
class	HdRendererPlugin

Detailed Description

A handle for HdRendererPlugin also storing the plugin id.

Alleviates the need to ever call, e.g., ReleasePlugin since it automatically decreases and increases the plugin's reference counts with the plugin registry.

Definition at line 30 of file rendererPluginHandle.h.

Constructor & Destructor Documentation

HdRendererPluginHandle() [1/2]

HdRendererPluginHandle ( )

inline

Definition at line 33 of file rendererPluginHandle.h.

HdRendererPluginHandle() [2/2]

HdRendererPluginHandle ( const std::nullptr_t &  )

inline

Definition at line 34 of file rendererPluginHandle.h.

Member Function Documentation

Get()

HdRendererPlugin * Get ( ) const

inline

Get the wrapped HdRendererPlugin.

Definition at line 55 of file rendererPluginHandle.h.

operator bool()

operator bool ( ) const

inlineexplicit

Is the wrapped HdRendererPlugin valid?

Definition at line 61 of file rendererPluginHandle.h.

operator*()

HdRendererPlugin & operator* ( ) const

inline

Definition at line 58 of file rendererPluginHandle.h.

operator->()

HdRendererPlugin * operator-> ( ) const

inline

Definition at line 57 of file rendererPluginHandle.h.

Friends And Related Function Documentation

HdRendererPlugin

friend class HdRendererPlugin

friend

Definition at line 65 of file rendererPluginHandle.h.

HdRendererPluginRegistry

friend class HdRendererPluginRegistry

friend

Definition at line 64 of file rendererPluginHandle.h.

---

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

• pxr/imaging/hd/rendererPluginHandle.h