Public Member Functions | List of all members
sf::ResourcePtr< T > Class Template Reference

Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed. More...

#include <Resource.hpp>

Public Member Functions

 ResourcePtr ()
 Default constructor.
 ResourcePtr (const T *Resource)
 Construct from a raw resource.
 ResourcePtr (const ResourcePtr< T > &Copy)
 Copy constructor.
 ~ResourcePtr ()
 Destructor.
ResourcePtr< T > & operator= (const ResourcePtr< T > &Other)
 Assignment operator from another ResourcePtr.
ResourcePtr< T > & operator= (const T *Resource)
 Assignment operator from a raw resource.
 operator const T * () const
 Cast operator to implicitely convert the resource pointer to its raw pointer type.
const T & operator* () const
 Operator * overload to return a reference to the actual resource.
const T * operator-> () const
 Operator -> overload to return a pointer to the actual resource.
void OnResourceDestroyed ()
 Function called when the observed resource is about to be destroyed.

Detailed Description

template<typename T>
class sf::ResourcePtr< T >

Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed.

Definition at line 116 of file Resource.hpp.

Constructor & Destructor Documentation

◆ ResourcePtr() [1/3]

template<typename T>
ResourcePtr::ResourcePtr ( )

Default constructor.

Definition at line 31 of file Resource.hpp.

◆ ResourcePtr() [2/3]

template<typename T>
ResourcePtr::ResourcePtr ( const T * Resource)

Construct from a raw resource.

Parameters
Resource: Internal resource

Definition at line 42 of file Resource.hpp.

◆ ResourcePtr() [3/3]

template<typename T>
ResourcePtr::ResourcePtr ( const ResourcePtr< T > & Copy)

Copy constructor.

Parameters
Copy: Instance to copy

Definition at line 54 of file Resource.hpp.

◆ ~ResourcePtr()

template<typename T>
ResourcePtr::~ResourcePtr ( )

Destructor.

Definition at line 66 of file Resource.hpp.

Member Function Documentation

◆ OnResourceDestroyed()

template<typename T>
void ResourcePtr::OnResourceDestroyed ( )

Function called when the observed resource is about to be destroyed.

Definition at line 147 of file Resource.hpp.

◆ operator const T *()

template<typename T>
ResourcePtr::operator const T * ( ) const

Cast operator to implicitely convert the resource pointer to its raw pointer type.

This might be dangerous in the general case, but in this context it is safe enough to define this operator

Returns
Pointer to the actual resource

This might be dangerous in the general case, but in this context it is safe enough to define this operator

Definition at line 116 of file Resource.hpp.

◆ operator*()

template<typename T>
const T & ResourcePtr::operator* ( ) const

Operator * overload to return a reference to the actual resource.

Returns
Reference to the internal resource

Definition at line 126 of file Resource.hpp.

◆ operator->()

template<typename T>
const T * ResourcePtr::operator-> ( ) const

Operator -> overload to return a pointer to the actual resource.

Returns
Pointer to the internal resource

Definition at line 136 of file Resource.hpp.

◆ operator=() [1/2]

template<typename T>
ResourcePtr< T > & ResourcePtr::operator= ( const ResourcePtr< T > & Other)

Assignment operator from another ResourcePtr.

Parameters
Other: Resource pointer to assign
Returns
Reference to this

Definition at line 77 of file Resource.hpp.

◆ operator=() [2/2]

template<typename T>
ResourcePtr< T > & ResourcePtr::operator= ( const T * Resource)

Assignment operator from a raw resource.

Parameters
Resource: Resource to assign
Returns
Reference to this

Definition at line 95 of file Resource.hpp.

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