Manager for Dynamic-loading Libraries. More...

#include <OgreDynLibManager.h>

Inheritance diagram for Ogre::DynLibManager:

Public Member Functions
	DynLibManager ()
	Default constructor.

virtual	~DynLibManager ()
	Default destructor.

DynLib *	load (const String &filename, const bool bOptional)
	Loads the passed library.

void	unload (DynLib *lib)
	Unloads the passed library.

Public Member Functions inherited from Ogre::Singleton< DynLibManager >
	Singleton ()

	~Singleton ()

Static Public Member Functions
static DynLibManager &	getSingleton ()
	Override standard Singleton retrieval.

static DynLibManager *	getSingletonPtr ()
	Override standard Singleton retrieval.

Static Public Member Functions inherited from Ogre::Singleton< DynLibManager >
static DynLibManager &	getSingleton ()

static DynLibManager *	getSingletonPtr ()

Detailed Description

Manager for Dynamic-loading Libraries.

Remarks: This manager keeps a track of all the open dynamic-loading libraries, opens them and returns references to already-open libraries.

Constructor & Destructor Documentation

◆ DynLibManager()

Ogre::DynLibManager::DynLibManager ( )

Default constructor.

Note: Should never be called as the singleton is automatically created during the creation of the Root object.

See also: Root::Root

◆ ~DynLibManager()

virtual Ogre::DynLibManager::~DynLibManager ( )

virtual

Default destructor.

See also: Root::~Root

Member Function Documentation

◆ getSingleton()

static DynLibManager & Ogre::DynLibManager::getSingleton ( )

static

Override standard Singleton retrieval.

Remarks: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

◆ getSingletonPtr()

static DynLibManager * Ogre::DynLibManager::getSingletonPtr ( )

static

Override standard Singleton retrieval.

Remarks: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

◆ load()

DynLib * Ogre::DynLibManager::load	(	const String &	filename,
		const bool	bOptional
	)

Loads the passed library.

Parameters

filename	The name of the library. The extension can be omitted.
bOptional	When true, we will skip it if it fails to initialize

◆ unload()

void Ogre::DynLibManager::unload ( DynLib * lib )

Unloads the passed library.