ObjectPtr#

Fully qualified name: carb::ObjectPtr

Defined in carb/IObject.h

template<class T>
class ObjectPtr#

Smart pointer type for ref counting IObject.

It automatically controls reference count for the underlying IObject pointer.

Public Types

using InitPolicy = carb::InitPolicy#

Policy directing how the smart pointer is initialized from from raw pointer.

This is provided for backwards compatibility. Instead, prefer using carb::InitPolicy.

Public Functions

inline constexpr ObjectPtr() noexcept#

Default Constructor.

inline constexpr ObjectPtr(std::nullptr_t) noexcept#

Nullptr Constructor.

inline explicit ObjectPtr(T *object)#

Constructor.

Parameters:

object – The raw pointer to an object. If not nullptr, it will be “borrowed”; that is, the reference count will be increased as long as *this contains it.

inline ObjectPtr(T *object, InitPolicy policy)#

Constructor.

Parameters:

• object – The raw pointer to an object.

• policy – Directive on whether the reference count should be increased or not.

inline ObjectPtr(const ObjectPtr<T> &other)#

Copy constructor.

Always increases the reference count.

Parameters:

other – The smart pointer from which to copy a reference.

template<class U>
inline ObjectPtr(const ObjectPtr<U> &other)#

Copy constructor.

Always increases the reference count.

Parameters:

other – The smart pointer from which to copy a reference.

inline constexpr ObjectPtr(ObjectPtr<T> &&other) noexcept#

Move constructor.

Steals the reference count from other and leaves it empty.

Parameters:

other – The smart pointer from which to steal a reference.

template<class U>
inline constexpr ObjectPtr(

ObjectPtr<U> &&other,

) noexcept#

Move constructor.

Steals the reference count from other and leaves it empty.

Parameters:

other – The smart pointer from which to steal a reference.

inline ~ObjectPtr()#

Destructor.

inline constexpr T *get() const noexcept#

Converts the smart pointer to a raw pointer.

Returns:

The raw pointer referenced by the smart pointer. May be nullptr.

inline constexpr T *operator->() const noexcept#

Pointer dereference operator.

Returns:

The raw pointer referenced by the smart pointer.

inline constexpr T &operator*() const noexcept#

Dereference operator.

Returns:

A reference to the pointed-at object.

inline explicit constexpr operator bool() const noexcept#

Boolean conversion operator.

Returns:

true if the smart pointer is not empty; false if the smart pointer is empty.

inline T *const *getAddressOf() const#

Returns the address of the internal reference.

Returns:

The address of the internal reference.

inline T **getAddressOf()#

Returns the address of the internal reference.

Returns:

The address of the internal reference.

inline T **releaseAndGetAddressOf()#

Helper function to release any current reference and return the address of the internal reference pointer.

Warning

This function calls release() on the contained object (if any), sets *this to nullptr and then returns a pointer to the internal pointer. When *this is destroyed any value assigned to the internal pointer will also have release() called on it.

Returns:

The address of the internal reference.

inline T *detach()#

Resets this smart pointer to nullptr and returns the previously reference object without releasing the held reference.

Returns:

The previously referenced object.

inline void attach(T *other)#

Releases the reference on any held object and instead steals the given object.

Parameters:

other – The object to steal a reference to.

inline ObjectPtr &operator=(std::nullptr_t)#

Assignment to nullptr.

Releases any previously held reference.

Returns:

*this

inline ObjectPtr &operator=(T *other)#

Releases any previously held reference and copies a reference to other.

Parameters:

other – The object to reference.

Returns:

*this

template<typename U>
inline ObjectPtr &operator=(U *other)#

Assignment to nullptr.

Releases any previously held reference.

Returns:

*this

inline ObjectPtr &operator=(const ObjectPtr &other)#

Assignment to nullptr.

Releases any previously held reference.

Returns:

*this

template<class U>
inline ObjectPtr &operator=(

const ObjectPtr<U> &other,

)#

Assignment to nullptr.

Releases any previously held reference.

Returns:

*this

inline ObjectPtr &operator=(ObjectPtr &&other)#

Releases any previously held reference and steals the reference from other.

Parameters:

other – The reference to steal. Will be swapped with *this.

Returns:

*this

template<class U>
inline ObjectPtr &operator=(

ObjectPtr<U> &&other,

)#

Releases any previously held reference and steals the reference from other.

Parameters:

other – The reference to steal. Will be swapped with *this.

Returns:

*this

inline void swap(ObjectPtr &other)#

Swaps with another smart pointer.

Parameters:

other – The smart pointer to swap with.

inline constexpr T *release() noexcept#

Releases the ownership of the managed object if any.

get() returns nullptr after calling this function. The caller is responsible for cleaning up the returned object.

Warning

This function releases the ownership of *this without calling release() on the returned object!

Returns:

pointer to the previously managed object, or nullptr if there was no managed object.

inline void reset(

T *ptr = nullptr,

InitPolicy policy = InitPolicy::eSteal,

)#

Replaces the managed object.

Equivalent to ObjectPtr(ptr).swap(*this). If ptr is not nullptr, it will be borrowed (that is, addRef() will be called on it), and then release() will be called on the managed object, if it was not nullptr.

Parameters:

• ptr – The new object to manage, or nullptr to manage nothing.

• policy – The InitPolicy indicating whether the reference count should be increased or not.