This is the documentation for Enlighten.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Classes

Name Description
Geo::GeoAlignedFreeDestructor

A type for freeing objects using GEO_ALIGNED_FREE. This is for use in GeoAutoPtr.

Geo::GeoAutoArrayPtr

Given the lack of a template typedef, and how common it is to want a GeoAutoPtr with Array dtor, adding a new class to provide this destruction policy by default.

Geo::GeoAutoPtr

A value type to take ownership of a raw object allocated on the heap and bind its life-time to the scope of this class.

Geo::GeoAutoReleasePtr

Given the lack of a template typedef, and how common it is to want a GeoAutoPtr with Release dtor, adding a new class to provide this destruction policy by default.

Geo::GeoDelegateDestructor

A type for deleting objects of type T using specific delete function. This is for use in GeoAutoPtr.

Geo::GeoDeleteArrayDestructor

A type for deleting objects of type T using DeleteArray().

Geo::GeoDeleteDestructor

A type for deleting objects of type T using GEO_DELETE.

Geo::GeoFreeDestructor

A type for freeing objects using GEO_FREE. This is for use in GeoAutoPtr.

Geo::GeoInstanceCount
Geo::GeoIntrusivePtr

A value type to take ownership of a raw object allocated on the heap and handle calling AddRef() and Release().

Geo::GeoNoopDestructor

A type for not destroying anything.

Geo::GeoRefArrayPtr

Given the lack of a template typedef, and how common it is to want a GeoRefPtr with Array dtor, adding a new class to provide this destruction policy by default.

Geo::GeoRefCount

Base class for reference counted resources.

Geo::GeoRefPtr

A value type to take ownership of a raw object allocated on the heap and track a reference count between multiple instances of this class.

Geo::GeoRefReleasePtr

Given the lack of a template typedef, and how common it is to want a GeoRefPtr with Release dtor, adding a new class to provide this destruction policy by default.

Geo::GeoReleaseDestructor

A type for deleting objects of type T using Release(). This is for use in GeoAutoPtr.

Geo::GeoSingleton

Inherit from this class to add singleton behaviour to your class.

Variables

Name Description
tClass * m_Singleton = NULL

Pointer to the singleton instance or NULL if not started.

Functions

Name Description
Get()

Returns a pointer to the singleton instance.

IsAvailable()

Returns true if the singleton is available.

Start()

Setup the singleton instance.

Stop()

Release the singleton instance.


tClass * Geo::GeoSingleton< tClass >::Get


public: tClass * Get()


Returns a pointer to the singleton instance.


bool Geo::GeoSingleton< tClass >::IsAvailable


public: bool IsAvailable()


Returns true if the singleton is available.


bool Geo::GeoSingleton< tClass >::Start


public: bool Start()


Setup the singleton instance.


void Geo::GeoSingleton< tClass >::Stop


public: void Stop()


Release the singleton instance.

  • No labels