OGRE  1.9.0
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.
 
 ~ExternalTextureSourceManager ()
 Destructor.
 
void 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.
 
ExternalTextureSourcegetCurrentPlugIn (void) const
 Returns currently selected plugin, may be null if none selected.
 
ExternalTextureSourcegetExternalTextureSource (const String &sTexturePlugInType)
 Returns the plugin which registered itself with a specific name (eg.
 
void operator delete (void *ptr)
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info
 
void * operator new (size_t sz, void *ptr)
 placement operator new
 
void * operator new (size_t sz, void *ptr)
 placement operator new
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info
 
void setCurrentPlugIn (const String &sTexturePlugInType)
 Sets active plugin (ie.
 
void setExternalTextureSource (const String &sTexturePlugInType, ExternalTextureSource *pTextureSystem)
 Called from plugin to register itself.
 

Static Public Member Functions

static ExternalTextureSourceManagergetSingleton (void)
 Override standard Singleton retrieval.
 
static ExternalTextureSourceManagergetSingletonPtr (void)
 Override standard Singleton retrieval.
 

Protected Types

typedef map< String, ExternalTextureSource * >::type TextureSystemList
 

Protected Attributes

ExternalTextureSourcemCurrExternalTextureSource
 The current texture controller selected.
 
TextureSystemList mTextureSystems
 

Static Protected Attributes

static ExternalTextureSourceManagermsSingleton
 

Detailed Description

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

The plugins will be mostly controlled via a string interface.

Definition at line 56 of file OgreExternalTextureSourceManager.h.

Member Typedef Documentation

◆ TextureSystemList

Constructor & Destructor Documentation

◆ ExternalTextureSourceManager()

Ogre::ExternalTextureSourceManager::ExternalTextureSourceManager ( )

Constructor.

Referenced by getSingleton(), and getSingletonPtr().

◆ ~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.

References Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME.

◆ getCurrentPlugIn()

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

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

Definition at line 68 of file OgreExternalTextureSourceManager.h.

References mCurrExternalTextureSource.

◆ 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 ( void )
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.

References ExternalTextureSourceManager().

◆ getSingletonPtr()

static ExternalTextureSourceManager * Ogre::ExternalTextureSourceManager::getSingletonPtr ( void )
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.

References ExternalTextureSourceManager().

◆ operator delete() [1/6]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete ( void * ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [2/6]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete ( void * ptr)
inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [3/6]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [4/6]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [5/6]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete ( void * ptr,
void *  )
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete() [6/6]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete ( void * ptr,
void *  )
inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [1/4]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete[] ( void * ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [2/4]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete[] ( void * ptr)
inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [3/4]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete[] ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator delete[]() [4/4]

void Ogre::AllocatedObject< ResourceAllocPolicy >::operator delete[] ( void * ptr,
const char * ,
int ,
const char *  )
inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

◆ operator new() [1/6]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new ( size_t sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [2/6]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new ( size_t sz)
inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/6]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new ( size_t sz,
const char * file,
int line,
const char * func )
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [4/6]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new ( size_t sz,
const char * file,
int line,
const char * func )
inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [5/6]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new ( size_t sz,
void * ptr )
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new() [6/6]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new ( size_t sz,
void * ptr )
inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/4]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new[] ( size_t sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/4]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new[] ( size_t sz)
inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [3/4]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new[] ( size_t sz,
const char * file,
int line,
const char * func )
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [4/4]

void * Ogre::AllocatedObject< ResourceAllocPolicy >::operator new[] ( size_t sz,
const char * file,
int line,
const char * func )
inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ 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.

Member Data Documentation

◆ mCurrExternalTextureSource

ExternalTextureSource* Ogre::ExternalTextureSourceManager::mCurrExternalTextureSource
protected

The current texture controller selected.

Definition at line 116 of file OgreExternalTextureSourceManager.h.

Referenced by getCurrentPlugIn().

◆ msSingleton

Definition at line 75 of file OgreSingleton.h.

◆ mTextureSystems

TextureSystemList Ogre::ExternalTextureSourceManager::mTextureSystems
protected

Definition at line 120 of file OgreExternalTextureSourceManager.h.


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