OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::ExternalTextureSourceManager Class Reference

Singleton Class which handles the registering and control of texture plugins. More...

#include <OgreExternalTextureSourceManager.h>

+ Inheritance diagram for Ogre::ExternalTextureSourceManager:

Public Member Functions

 ExternalTextureSourceManager ()
 Constructor. More...
 
 ~ExternalTextureSourceManager ()
 Destructor. More...
 
void destroyAdvancedTexture (const String &sTextureName, const String &groupName=ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME)
 Calls the destroy method of all registered plugins... More...
 
ExternalTextureSourcegetCurrentPlugIn () const
 Returns currently selected plugin, may be null if none selected. More...
 
ExternalTextureSourcegetExternalTextureSource (const String &sTexturePlugInType)
 Returns the plugin which registered itself with a specific name (eg. More...
 
void setCurrentPlugIn (const String &sTexturePlugInType)
 Sets active plugin (ie. More...
 
void setExternalTextureSource (const String &sTexturePlugInType, ExternalTextureSource *pTextureSystem)
 Called from plugin to register itself. More...
 
- Public Member Functions inherited from Ogre::Singleton< ExternalTextureSourceManager >
 Singleton ()
 
 ~Singleton ()
 

Static Public Member Functions

static ExternalTextureSourceManagergetSingleton ()
 Override standard Singleton retrieval. More...
 
static ExternalTextureSourceManagergetSingletonPtr ()
 Override standard Singleton retrieval. More...
 
- Static Public Member Functions inherited from Ogre::Singleton< ExternalTextureSourceManager >
static ExternalTextureSourceManagergetSingleton ()
 
static ExternalTextureSourceManagergetSingletonPtr ()
 

Detailed Description

Singleton Class which handles the registering and control of texture plugins.

The plugins will be mostly controlled via a string interface.

Constructor & Destructor Documentation

◆ ExternalTextureSourceManager()

Ogre::ExternalTextureSourceManager::ExternalTextureSourceManager ( )

Constructor.

◆ ~ExternalTextureSourceManager()

Ogre::ExternalTextureSourceManager::~ExternalTextureSourceManager ( )

Destructor.

Member Function Documentation

◆ destroyAdvancedTexture()

void Ogre::ExternalTextureSourceManager::destroyAdvancedTexture ( const String sTextureName,
const String groupName = ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME 
)

Calls the destroy method of all registered plugins...

Only the owner plugin should perform the destroy action.

◆ getCurrentPlugIn()

ExternalTextureSource* Ogre::ExternalTextureSourceManager::getCurrentPlugIn ( ) const
inline

Returns currently selected plugin, may be null if none selected.

◆ getExternalTextureSource()

ExternalTextureSource* Ogre::ExternalTextureSourceManager::getExternalTextureSource ( const String sTexturePlugInType)

Returns the plugin which registered itself with a specific name (eg.

"video"), or null if specified plugin not found

◆ getSingleton()

static ExternalTextureSourceManager& Ogre::ExternalTextureSourceManager::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 ExternalTextureSourceManager* Ogre::ExternalTextureSourceManager::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.

◆ setCurrentPlugIn()

void Ogre::ExternalTextureSourceManager::setCurrentPlugIn ( const String sTexturePlugInType)

Sets active plugin (ie.

"video", "effect", "generic", etc..)

◆ setExternalTextureSource()

void Ogre::ExternalTextureSourceManager::setExternalTextureSource ( const String sTexturePlugInType,
ExternalTextureSource pTextureSystem 
)

Called from plugin to register itself.


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