All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdRendererPluginHandle Class Referencefinal

#include <rendererPluginHandle.h>

Public Member Functions

 HdRendererPluginHandle ()
 HdRendererPluginHandle (const std::nullptr_t &)
HD_API HdRendererPluginHandle (const HdRendererPluginHandle &)
HD_API ~HdRendererPluginHandle ()
HD_API HdRendererPluginHandleoperator= (const HdRendererPluginHandle &)
HD_API HdRendererPluginHandleoperator= (const std::nullptr_t &)
HdRendererPluginGet () const
 Get the wrapped HdRendererPlugin. More...
HdRendererPluginoperator-> () const
HdRendererPluginoperator* () const
 operator bool () const
 Is the wrapped HdRendererPlugin valid? More...


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 47 of file rendererPluginHandle.h.

Constructor & Destructor Documentation

HdRendererPluginHandle::HdRendererPluginHandle ( )

Definition at line 50 of file rendererPluginHandle.h.

HdRendererPluginHandle::HdRendererPluginHandle ( const std::nullptr_t &  )

Definition at line 51 of file rendererPluginHandle.h.

HD_API HdRendererPluginHandle::HdRendererPluginHandle ( const HdRendererPluginHandle )
HD_API HdRendererPluginHandle::~HdRendererPluginHandle ( )

Member Function Documentation

HdRendererPlugin* HdRendererPluginHandle::Get ( ) const

Get the wrapped HdRendererPlugin.

Definition at line 66 of file rendererPluginHandle.h.

HdRendererPluginHandle::operator bool ( ) const

Is the wrapped HdRendererPlugin valid?

Definition at line 72 of file rendererPluginHandle.h.

HdRendererPlugin& HdRendererPluginHandle::operator* ( ) const

Definition at line 69 of file rendererPluginHandle.h.

HdRendererPlugin* HdRendererPluginHandle::operator-> ( ) const

Definition at line 68 of file rendererPluginHandle.h.

HD_API HdRendererPluginHandle& HdRendererPluginHandle::operator= ( const HdRendererPluginHandle )
HD_API HdRendererPluginHandle& HdRendererPluginHandle::operator= ( const std::nullptr_t &  )

Friends And Related Function Documentation

friend class HdRendererPlugin

Definition at line 76 of file rendererPluginHandle.h.

Definition at line 75 of file rendererPluginHandle.h.

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