OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::RTShader::ProgramWriterManager Class Reference

#include <OgreShaderProgramWriterManager.h>

+ Inheritance diagram for Ogre::RTShader::ProgramWriterManager:
+ Collaboration diagram for Ogre::RTShader::ProgramWriterManager:

Public Types

typedef map< String,
ProgramWriterFactory * >::type 
FactoryMap
 

Public Member Functions

 ProgramWriterManager ()
 
 ~ProgramWriterManager ()
 
void addFactory (ProgramWriterFactory *factory)
 Add a new factory object for high-level programs of a given language. More...
 
ProgramWritercreateProgramWriter (const String &language)
 Create a new, unloaded HighLevelGpuProgram. More...
 
bool isLanguageSupported (const String &lang)
 Returns whether a given high-level language is supported. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
void removeFactory (ProgramWriterFactory *factory)
 Remove a factory object for high-level programs of a given language. More...
 

Static Public Member Functions

static ProgramWriterManagergetSingleton ()
 Override standard Singleton retrieval. More...
 
static ProgramWriterManagergetSingletonPtr ()
 Override standard Singleton retrieval. More...
 

Protected Attributes

FactoryMap mFactories
 Factories capable of creating ShaderProgramWriterFactory instances. More...
 

Static Protected Attributes

static ProgramWriterManagermsSingleton
 

Detailed Description

Definition at line 60 of file OgreShaderProgramWriterManager.h.

Member Typedef Documentation

Constructor & Destructor Documentation

Ogre::RTShader::ProgramWriterManager::ProgramWriterManager ( )
Ogre::RTShader::ProgramWriterManager::~ProgramWriterManager ( )

Member Function Documentation

void Ogre::RTShader::ProgramWriterManager::addFactory ( ProgramWriterFactory factory)

Add a new factory object for high-level programs of a given language.

ProgramWriter* Ogre::RTShader::ProgramWriterManager::createProgramWriter ( const String language)

Create a new, unloaded HighLevelGpuProgram.

This method creates a new program of the type specified as the second and third parameters. You will have to call further methods on the returned program in order to define the program fully before you can load it.
Parameters
languageCode of the language to use (e.g. "cg")
static ProgramWriterManager& Ogre::RTShader::ProgramWriterManager::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.
static ProgramWriterManager* Ogre::RTShader::ProgramWriterManager::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.
bool Ogre::RTShader::ProgramWriterManager::isLanguageSupported ( const String lang)

Returns whether a given high-level language is supported.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::RTShader::ProgramWriterManager::removeFactory ( ProgramWriterFactory factory)

Remove a factory object for high-level programs of a given language.

Member Data Documentation

FactoryMap Ogre::RTShader::ProgramWriterManager::mFactories
protected

Factories capable of creating ShaderProgramWriterFactory instances.

Definition at line 67 of file OgreShaderProgramWriterManager.h.

ProgramWriterManager * Ogre::Singleton< ProgramWriterManager >::msSingleton
staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.


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