#include <CeresEngine/Resource/ResourceHandle.hpp>

Inheritance diagram for CeresEngine::ResourceHandle< T >:

Public Member Functions
	ResourceHandle () noexcept=default

	ResourceHandle (std::nullptr_t) noexcept

ResourceHandle &	operator= (std::nullptr_t)

	ResourceHandle (const ResourceHandle &other)

ResourceHandle &	operator= (const ResourceHandle &other)

template<typename U > requires (std::is_convertible_v<U, T>)
	ResourceHandle (const ResourceHandle< U > &other) noexcept

template<typename U > requires (std::is_convertible_v<U, T>)
ResourceHandle &	operator= (const ResourceHandle< U > &other)

	ResourceHandle (ResourceHandle &&other) noexcept

ResourceHandle &	operator= (ResourceHandle &&other) noexcept

template<typename U > requires (std::is_convertible_v<U, T>)
	ResourceHandle (ResourceHandle< U > &&other) noexcept

template<typename U > requires (std::is_convertible_v<U, T>)
ResourceHandle &	operator= (ResourceHandle< U > &&other)

	ResourceHandle (SPtr< T > resource) noexcept

	~ResourceHandle () noexcept

T *	get () const noexcept

SPtr< T >	getPointer () const noexcept

T *	operator-> () const noexcept

T &	operator* () const noexcept

Async< ResourceHandle< T > >	load () const
	Loads the resource, if not loaded.

template<typename Func >
EventConnection	didLoadResource (Func &&func)
	Attaches a new event that will called whenever the.

template<typename Func >
EventConnection	didUnloadResource (Func &&func)

Public Member Functions inherited from CeresEngine::AbstractResourceHandle
	AbstractResourceHandle ()=default

	AbstractResourceHandle (ResourceHandleData *data)

	AbstractResourceHandle (SPtr< Resource > resource) noexcept

const UUID &	getUUID () const noexcept

bool	isValid () const noexcept
	Checks if the resource handle is valid.

Async< HResource >	load () const
	Loads the resource, if not loaded.

bool	isLoaded () const noexcept
	Checks if the resource handle is valid and loaded.

	operator bool () const noexcept
	Checks if the resource handle is valid.

void	reset ()
	Resets the resource handle to the default state.

Private Member Functions
	ResourceHandle (ResourceHandleData *data)

Friends
class	ResourceManager

class	AbstractResourceHandle

class	ResourceHandleData

template<typename >
class	ResourceHandle

template<typename >
class	WeakResourceHandle

template<typename U1 , typename U2 >
bool	operator== (const ResourceHandle< U1 > &lhs, const ResourceHandle< U2 > &rhs) noexcept
	Checks if both references represent the same handle.

template<typename U1 , typename U2 >
bool	operator!= (const ResourceHandle< U1 > &lhs, const ResourceHandle< U2 > &rhs) noexcept
	Checks if both references not represent the same handle.

template<typename U >
bool	operator== (const ResourceHandle< U > &lhs, std::nullptr_t) noexcept
	Checks if the reference `lhs` is `nullptr`.

template<typename U >
bool	operator== (std::nullptr_t, const ResourceHandle< U > &rhs) noexcept
	Checks if both references represent the same handle.

template<typename U >
bool	operator!= (const ResourceHandle< U > &lhs, std::nullptr_t) noexcept
	Checks if the reference `lhs` is not `nullptr`.

template<typename U >
bool	operator!= (std::nullptr_t, const ResourceHandle< U > &rhs) noexcept
	Checks if both references not represent the same handle.

template<typename U , typename V >
ResourceHandle< U >	static_resource_cast (const ResourceHandle< V > &handle)

template<typename U , typename V >
ResourceHandle< U >	static_resource_cast (ResourceHandle< V > &&handle)

Additional Inherited Members
Protected Member Functions inherited from CeresEngine::AbstractResourceHandle
void	set (ResourceHandleData *const data) noexcept
	Changes the internal resource handle data object of the handle.

Protected Attributes inherited from CeresEngine::AbstractResourceHandle
ResourceHandleData *	mData = nullptr

Constructor & Destructor Documentation

◆ ResourceHandle() [1/8]

template<typename T >

CeresEngine::ResourceHandle< T >::ResourceHandle ( )

defaultnoexcept

◆ ResourceHandle() [2/8]

template<typename T >

CeresEngine::ResourceHandle< T >::ResourceHandle ( std::nullptr_t )

inlinenoexcept

◆ ResourceHandle() [3/8]

template<typename T >

CeresEngine::ResourceHandle< T >::ResourceHandle ( const ResourceHandle< T > & other )

inline

◆ ResourceHandle() [4/8]

template<typename T >

template<typename U >
requires (std::is_convertible_v<U*, T*>)

CeresEngine::ResourceHandle< T >::ResourceHandle ( const ResourceHandle & other )

inlinenoexcept

◆ ResourceHandle() [5/8]

template<typename T >

CeresEngine::ResourceHandle< T >::ResourceHandle ( ResourceHandle< T > && other )

inlinenoexcept

◆ ResourceHandle() [6/8]

template<typename T >

template<typename U >
requires (std::is_convertible_v<U*, T*>)

CeresEngine::ResourceHandle< T >::ResourceHandle ( ResourceHandle && other )

inlinenoexcept

◆ ResourceHandle() [7/8]

template<typename T >

CeresEngine::ResourceHandle< T >::ResourceHandle ( SPtr< T > resource )

inlineexplicitnoexcept

◆ ~ResourceHandle()

template<typename T >

CeresEngine::ResourceHandle< T >::~ResourceHandle ( )

inlinenoexcept

◆ ResourceHandle() [8/8]

template<typename T >

CeresEngine::ResourceHandle< T >::ResourceHandle ( ResourceHandleData * data )

inlineexplicitprivate

Member Function Documentation

◆ didLoadResource()

template<typename T >

template<typename Func >

EventConnection CeresEngine::ResourceHandle< T >::didLoadResource ( Func && func )

inline

Attaches a new event that will called whenever the.

Template Parameters

Func

Parameters

func

Returns

◆ didUnloadResource()

template<typename T >

template<typename Func >

EventConnection CeresEngine::ResourceHandle< T >::didUnloadResource ( Func && func )

inline

◆ get()

template<typename T >

T * CeresEngine::ResourceHandle< T >::get ( ) const

inlinenoexcept

◆ getPointer()

template<typename T >

SPtr< T > CeresEngine::ResourceHandle< T >::getPointer ( ) const

inlinenoexcept

◆ load()

template<typename T >

Async< ResourceHandle< T > > CeresEngine::ResourceHandle< T >::load ( ) const

Loads the resource, if not loaded.

◆ operator*()

template<typename T >

T & CeresEngine::ResourceHandle< T >::operator* ( ) const

inlinenoexcept

◆ operator->()

template<typename T >

T * CeresEngine::ResourceHandle< T >::operator-> ( ) const

inlinenoexcept

◆ operator=() [1/5]

template<typename T >

ResourceHandle & CeresEngine::ResourceHandle< T >::operator= ( const ResourceHandle< T > & other )

inline

◆ operator=() [2/5]

template<typename T >

template<typename U >
requires (std::is_convertible_v<U*, T*>)

ResourceHandle & CeresEngine::ResourceHandle< T >::operator= ( const ResourceHandle & other )

inline

◆ operator=() [3/5]

template<typename T >

ResourceHandle & CeresEngine::ResourceHandle< T >::operator= ( ResourceHandle< T > && other )

inlinenoexcept

◆ operator=() [4/5]

template<typename T >

template<typename U >
requires (std::is_convertible_v<U*, T*>)

ResourceHandle & CeresEngine::ResourceHandle< T >::operator= ( ResourceHandle && other )

inline

◆ operator=() [5/5]

template<typename T >

ResourceHandle & CeresEngine::ResourceHandle< T >::operator= ( std::nullptr_t )

inline

Friends And Related Symbol Documentation

◆ AbstractResourceHandle

template<typename T >

friend class AbstractResourceHandle

friend

◆ operator!= [1/3]

template<typename T >

template<typename U >

bool operator!=	(	const ResourceHandle< U > &	lhs,
		std::nullptr_t
	)

friend

Checks if the reference lhs is not nullptr.

Template Parameters

U	The resource type

Parameters

lhs	The first operand

Returns: true if lhs is not nullptr

◆ operator!= [2/3]

template<typename T >

template<typename U1 , typename U2 >

bool operator!=	(	const ResourceHandle< U1 > &	lhs,
		const ResourceHandle< U2 > &	rhs
	)

friend

Checks if both references not represent the same handle.

Template Parameters

U1	The first resource type
U2	The second resource type

Parameters

lhs	The first operand
rhs	The second operand

Returns: true if both lhs and rhs do not represent the same handle

◆ operator!= [3/3]

template<typename T >

template<typename U >

bool operator!=	(	std::nullptr_t	,
		const ResourceHandle< U > &	rhs
	)

friend

Checks if both references not represent the same handle.

Template Parameters

U1	The first resource type
U2	The second resource type

Parameters

lhs	The first operand
rhs	The second operand

Returns: true if both lhs and rhs do not represent the same handle

◆ operator== [1/3]

template<typename T >

template<typename U >

bool operator==	(	const ResourceHandle< U > &	lhs,
		std::nullptr_t
	)

friend

Checks if the reference lhs is nullptr.

Template Parameters

U	The resource type

Parameters

lhs	The first operand

Returns: true if lhs is nullptr

◆ operator== [2/3]

template<typename T >

template<typename U1 , typename U2 >

bool operator==	(	const ResourceHandle< U1 > &	lhs,
		const ResourceHandle< U2 > &	rhs
	)

friend

Checks if both references represent the same handle.

Template Parameters

U1	The first resource type
U2	The second resource type

Parameters

lhs	The first operand
rhs	The second operand

Returns: true if both lhs and rhs represent the same handle

◆ operator== [3/3]

template<typename T >

template<typename U >

bool operator==	(	std::nullptr_t	,
		const ResourceHandle< U > &	rhs
	)

friend

Checks if both references represent the same handle.

Template Parameters

U1	The first resource type
U2	The second resource type

Parameters

lhs	The first operand
rhs	The second operand

Returns: true if both lhs and rhs represent the same handle

◆ ResourceHandle

template<typename T >

template<typename >

friend class ResourceHandle

friend

◆ ResourceHandleData

template<typename T >

friend class ResourceHandleData

friend

◆ ResourceManager

template<typename T >

friend class ResourceManager

friend

◆ static_resource_cast [1/2]

template<typename T >

template<typename U , typename V >

ResourceHandle static_resource_cast ( const ResourceHandle< V > & handle )

friend

◆ static_resource_cast [2/2]

template<typename T >

template<typename U , typename V >

ResourceHandle static_resource_cast ( ResourceHandle< V > && handle )

friend

◆ WeakResourceHandle

template<typename T >

template<typename >

friend class WeakResourceHandle

friend

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Resource/Forward.hpp
/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Resource/ResourceHandle.hpp

Public Member Functions

Private Member Functions

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ ResourceHandle() [1/8]

◆ ResourceHandle() [2/8]

◆ ResourceHandle() [3/8]

◆ ResourceHandle() [4/8]

◆ ResourceHandle() [5/8]

◆ ResourceHandle() [6/8]

◆ ResourceHandle() [7/8]

◆ ~ResourceHandle()

◆ ResourceHandle() [8/8]

Member Function Documentation

◆ didLoadResource()

◆ didUnloadResource()

◆ get()

◆ getPointer()

◆ load()

◆ operator*()

◆ operator->()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

Friends And Related Symbol Documentation

◆ AbstractResourceHandle

◆ operator!= [1/3]

◆ operator!= [2/3]

◆ operator!= [3/3]

◆ operator== [1/3]

◆ operator== [2/3]

◆ operator== [3/3]

◆ ResourceHandle

◆ ResourceHandleData

◆ ResourceManager

◆ static_resource_cast [1/2]

◆ static_resource_cast [2/2]

◆ WeakResourceHandle