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

#include <pluginRenderDelegateUniqueHandle.h>

Public Member Functions

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


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

Constructor & Destructor Documentation

HdPluginRenderDelegateUniqueHandle::HdPluginRenderDelegateUniqueHandle ( )

Definition at line 50 of file pluginRenderDelegateUniqueHandle.h.

HdPluginRenderDelegateUniqueHandle::HdPluginRenderDelegateUniqueHandle ( const std::nullptr_t &  )

Definition at line 51 of file pluginRenderDelegateUniqueHandle.h.

HD_API HdPluginRenderDelegateUniqueHandle::HdPluginRenderDelegateUniqueHandle ( HdPluginRenderDelegateUniqueHandle &&  )

Transfer ownership.

HD_API HdPluginRenderDelegateUniqueHandle::~HdPluginRenderDelegateUniqueHandle ( )

Member Function Documentation

HdRenderDelegate* HdPluginRenderDelegateUniqueHandle::Get ( ) const

Get render delegate.

Definition at line 71 of file pluginRenderDelegateUniqueHandle.h.

HD_API TfToken HdPluginRenderDelegateUniqueHandle::GetPluginId ( ) const

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

HdPluginRenderDelegateUniqueHandle::operator bool ( ) const

Is the wrapped HdRenderDelegate valid?

Definition at line 77 of file pluginRenderDelegateUniqueHandle.h.

HdRenderDelegate& HdPluginRenderDelegateUniqueHandle::operator* ( ) const

Definition at line 74 of file pluginRenderDelegateUniqueHandle.h.

HdRenderDelegate* HdPluginRenderDelegateUniqueHandle::operator-> ( ) const

Definition at line 73 of file pluginRenderDelegateUniqueHandle.h.

HD_API HdPluginRenderDelegateUniqueHandle& HdPluginRenderDelegateUniqueHandle::operator= ( HdPluginRenderDelegateUniqueHandle &&  )

Transfer ownership.

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

Friends And Related Function Documentation

friend class HdRendererPlugin

Definition at line 84 of file pluginRenderDelegateUniqueHandle.h.

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