Handle that contains a hgi object and unique id. More...

#include <handle.h>

Public Member Functions
	HgiHandle (T *obj, uint64_t id)

T *	Get () const

uint64_t	GetId () const

	operator bool () const

T *	operator-> () const

bool	operator== (const HgiHandle &other) const

bool	operator!= (const HgiHandle &other) const

Detailed Description

template<class T>
class HgiHandle< T >

Handle that contains a hgi object and unique id.

The unique id is used to compare two handles to guard against pointer aliasing, where the same memory address is used to create a similar object, but it is not actually the same object.

Handle is not a shared or weak_ptr and destruction of the contained object should be explicitely managed by the client via the HgiDestroy*** functions.

If shared/weak ptr functionality is desired, the client creating Hgi objects can wrap the returned handle in a shared_ptr.

Definition at line 32 of file handle.h.

Constructor & Destructor Documentation

◆ HgiHandle() [1/2]

template<class T >

HgiHandle ( )

inline

Definition at line 35 of file handle.h.

◆ HgiHandle() [2/2]

template<class T >

HgiHandle	(	T *	obj,
		uint64_t	id )

bool operator== ( const HgiHandle< T > & other ) const

inline

Definition at line 53 of file handle.h.

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

pxr/imaging/hgi/handle.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ HgiHandle() [1/2]

◆ HgiHandle() [2/2]

Member Function Documentation

◆ Get()

◆ GetId()

◆ operator bool()

◆ operator!=()

◆ operator->()

◆ operator==()