Ogre::RTShader::ProgramWriterManager Class Reference
Core » RTShader

`#include <OgreShaderProgramWriterManager.h>`

Inheritance diagram for Ogre::RTShader::ProgramWriterManager:
[legend]

## 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...
ProgramWriter * | createProgramWriter (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 ProgramWriterManager & | getSingleton ()
| Override standard Singleton retrieval. More...
static ProgramWriterManager * | getSingletonPtr ()
| Override standard Singleton retrieval. More...

## Protected Attributes

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

## Static Protected Attributes

static ProgramWriterManager * | msSingleton

## Detailed Description

Definition at line 59 of file OgreShaderProgramWriterManager.h.

## Member Typedef Documentation

## FactoryMap

typedef map<String, ProgramWriterFactory*>::type Ogre::RTShader::ProgramWriterManager::FactoryMap

Definition at line 63 of file OgreShaderProgramWriterManager.h.

## Constructor & Destructor Documentation

## ProgramWriterManager()

Ogre::RTShader::ProgramWriterManager::ProgramWriterManager | ( |  | ) |

## ~ProgramWriterManager()

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

## Member Function Documentation

## addFactory()

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

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

## createProgramWriter()

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

  language | Code of the language to use (e.g. "cg")

## getSingleton()

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.

## getSingletonPtr()

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.

## isLanguageSupported()

bool Ogre::RTShader::ProgramWriterManager::isLanguageSupported | ( | const String & | lang | ) |

Returns whether a given high-level language is supported.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::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() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::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[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## removeFactory()

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

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

## Member Data Documentation

## mFactories

FactoryMap Ogre::RTShader::ProgramWriterManager::mFactories

protected

Factories capable of creating ShaderProgramWriterFactory instances.

Definition at line 66 of file OgreShaderProgramWriterManager.h.

## msSingleton

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

static protected inherited

Definition at line 75 of file OgreSingleton.h.

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

- OgreShaderProgramWriterManager.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.