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

Shader generator system main interface. More...

#include <OgreShaderGenerator.h>

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

Classes

class  SGMaterial
 Shader generator material wrapper class. More...
 
class  SGPass
 Shader generator pass wrapper class. More...
 
class  SGRenderObjectListener
 Shader generator RenderObjectListener sub class. More...
 
class  SGSceneManagerListener
 Shader generator scene manager sub class. More...
 
class  SGScheme
 Shader generator scheme class. More...
 
class  SGScriptTranslatorManager
 Shader generator ScriptTranslatorManager sub class. More...
 
class  SGTechnique
 Shader generator technique wrapper class. More...
 

Public Member Functions

void addSceneManager (SceneManager *sceneMgr)
 Add a scene manager to the shader generator scene managers list. More...
 
void addSubRenderStateFactory (SubRenderStateFactory *factory)
 Add sub render state factory. More...
 
void createScheme (const String &schemeName)
 Create a scheme. More...
 
bool createShaderBasedTechnique (const String &materialName, const String &srcTechniqueSchemeName, const String &dstTechniqueSchemeName)
 Create shader based technique from a given technique. More...
 
SubRenderStatecreateSubRenderState (const String &type)
 Create an instance of sub render state from a given type. More...
 
void destroySubRenderState (SubRenderState *subRenderState)
 Destroy an instance of sub render state. More...
 
void flushShaderCache ()
 Flush the shader cache. More...
 
SceneManagergetActiveSceneManager ()
 Get the active scene manager that is doint the actual scene rendering. More...
 
size_t getFragmentShaderCount () const
 Return the current number of generated fragment shaders. More...
 
const StringgetFragmentShaderProfiles () const
 Get the output fragment shader target profiles. More...
 
const StringVectorgetFragmentShaderProfilesList () const
 Get the output fragment shader target profiles as list of strings. More...
 
SGMaterialSerializerListenergetMaterialSerializerListener ()
 Return custom material Serializer of the shader generator. More...
 
RenderStategetRenderState (const String &schemeName)
 Return a global render state associated with the given scheme name. More...
 
RenderStategetRenderState (const String &schemeName, const String &materialName, unsigned short passIndex)
 Get render state of specific pass. More...
 
const StringgetShaderCachePath () const
 Get the output shader cache path. More...
 
const StringgetTargetLanguage () const
 Return the target shader language currently in use. More...
 
size_t getVertexShaderCount () const
 Return the current number of generated vertex shaders. More...
 
VSOutputCompactPolicy getVertexShaderOutputsCompactPolicy () const
 Get the vertex shader outputs compaction policy. More...
 
const StringgetVertexShaderProfiles () const
 Get the output vertex shader target profiles. More...
 
const StringVectorgetVertexShaderProfilesList () const
 Get the output vertex shader target profiles as list of strings. More...
 
void invalidateMaterial (const String &schemeName, const String &materialName)
 Invalidate specific material scheme. More...
 
void invalidateScheme (const String &schemeName)
 Invalidate a given scheme. 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)
 
bool removeAllShaderBasedTechniques (const String &materialName)
 Remove all shader based techniques of the given material. More...
 
void removeAllShaderBasedTechniques ()
 Remove all shader based techniques that created by this shader generator. More...
 
void removeSceneManager (SceneManager *sceneMgr)
 Remove a scene manager from the shader generator scene managers list. More...
 
bool removeShaderBasedTechnique (const String &materialName, const String &srcTechniqueSchemeName, const String &dstTechniqueSchemeName)
 Remove shader based technique from a given technique. More...
 
void removeSubRenderStateFactory (SubRenderStateFactory *factory)
 Remove sub render state factory. More...
 
void setFragmentShaderProfiles (const String &fragmentShaderProfiles)
 Set the output fragment shader target profiles. More...
 
void setShaderCachePath (const String &cachePath)
 Set the output shader cache path. More...
 
void setTargetLanguage (const String &shaderLanguage)
 Set the target shader language. More...
 
void setVertexShaderOutputsCompactPolicy (VSOutputCompactPolicy policy)
 Set the vertex shader outputs compaction policy. More...
 
void setVertexShaderProfiles (const String &vertexShaderProfiles)
 Set the output vertex shader target profiles. More...
 
bool validateMaterial (const String &schemeName, const String &materialName)
 Validate specific material scheme. More...
 
bool validateScheme (const String &schemeName)
 Validate a given scheme. More...
 

Static Public Member Functions

static void finalize ()
 Finalize the Shader Generator instance. More...
 
static ShaderGeneratorgetSingleton ()
 Override standard Singleton retrieval. More...
 
static ShaderGeneratorgetSingletonPtr ()
 Override standard Singleton retrieval. More...
 
static bool initialize ()
 Initialize the Shader Generator System. More...
 

Static Public Attributes

static String DEFAULT_SCHEME_NAME
 Default material scheme of the shader generator. More...
 

Protected Types

typedef
SceneManagerMap::const_iterator 
SceneManagerConstIterator
 
typedef SceneManagerMap::iterator SceneManagerIterator
 
typedef map< String,
SceneManager * >::type 
SceneManagerMap
 
typedef
SGMaterialMap::const_iterator 
SGMaterialConstIterator
 
typedef SGMaterialMap::iterator SGMaterialIterator
 
typedef map< String,
SGMaterial * >::type 
SGMaterialMap
 
typedef SGPassList::const_iterator SGPassConstIterator
 
typedef SGPassList::iterator SGPassIterator
 
typedef vector< SGPass * >::type SGPassList
 
typedef
SGMaterialMap::const_iterator 
SGSchemeConstIterator
 
typedef SGSchemeMap::iterator SGSchemeIterator
 
typedef map< String, SGScheme * >
::type 
SGSchemeMap
 
typedef
SGScriptTranslatorMap::const_iterator 
SGScriptTranslatorConstIterator
 
typedef
SGScriptTranslatorMap::iterator 
SGScriptTranslatorIterator
 
typedef map< String,
ScriptTranslator * >::type 
SGScriptTranslatorMap
 
typedef
SGTechniqueList::const_iterator 
SGTechniqueConstIterator
 
typedef SGTechniqueList::iterator SGTechniqueIterator
 
typedef vector< SGTechnique * >
::type 
SGTechniqueList
 
typedef map< SGTechnique
*, SGTechnique * >::type 
SGTechniqueMap
 
typedef SGTechniqueMap::iterator SGTechniqueMapIterator
 
typedef
SubRenderStateFactoryMap::const_iterator 
SubRenderStateFactoryConstIterator
 
typedef
SubRenderStateFactoryMap::iterator 
SubRenderStateFactoryIterator
 
typedef map< String,
SubRenderStateFactory * >
::type 
SubRenderStateFactoryMap
 

Protected Member Functions

 ShaderGenerator ()
 Class default constructor. More...
 
 ~ShaderGenerator ()
 Class destructor. More...
 
void _finalize ()
 Finalize the shader generator instance. More...
 
bool _initialize ()
 Initialize the shader generator instance. More...
 
bool addCustomScriptTranslator (const String &key, ScriptTranslator *translator)
 Add custom script translator. More...
 
SubRenderStatecreateSubRenderState (ScriptCompiler *compiler, PropertyAbstractNode *prop, Pass *pass)
 Create an instance of the SubRenderState based on script properties using the current sub render state factories. More...
 
void createSubRenderStateExFactories ()
 Create sub render state core extensions factories. More...
 
void destroySubRenderStateExFactories ()
 Destroy sub render state core extensions factories. More...
 
TechniquefindSourceTechnique (const String &materialName, const String &srcTechniqueSchemeName)
 Find source technique to generate shader based technique based on it. More...
 
size_t getNumTranslators () const
 Return number of script translators. More...
 
ScriptTranslatorgetTranslator (const AbstractNodePtr &node)
 Return a matching script translator. More...
 
void notifyRenderSingleObject (Renderable *rend, const Pass *pass, const AutoParamDataSource *source, const LightList *pLightList, bool suppressRenderStateChanges)
 Called from the sub class of the RenderObjectLister when single object is rendered. More...
 
void preFindVisibleObjects (SceneManager *source, SceneManager::IlluminationRenderStage irs, Viewport *v)
 Called from the sub class of the SceneManager::Listener when finding visible object process starts. More...
 
bool removeCustomScriptTranslator (const String &key)
 Remove custom script translator. More...
 
void serializePassAttributes (MaterialSerializer *ser, SGPass *passEntry)
 This method called by instance of SGMaterialSerializerListener and serialize a given pass entry attributes. More...
 

Protected Attributes

OGRE_AUTO_MUTEX SceneManagermActiveSceneMgr
 
bool mActiveViewportValid
 
SGScriptTranslator mCoreScriptTranslator
 
FFPRenderStateBuildermFFPRenderStateBuilder
 
String mFragmentShaderProfiles
 
StringVector mFragmentShaderProfilesList
 
int mLightCount [3]
 
SGMaterialMap mMaterialEntriesMap
 
SGMaterialSerializerListenermMaterialSerializerListener
 
ProgramManagermProgramManager
 
ProgramWriterManagermProgramWriterManager
 
SGRenderObjectListenermRenderObjectListener
 
SGSceneManagerListenermSceneManagerListener
 
SceneManagerMap mSceneManagerMap
 
SGSchemeMap mSchemeEntriesMap
 
SGScriptTranslatorManagermScriptTranslatorManager
 
SGScriptTranslatorMap mScriptTranslatorsMap
 
String mShaderCachePath
 
String mShaderLanguage
 
SubRenderStateFactoryMap mSubRenderStateExFactories
 
SubRenderStateFactoryMap mSubRenderStateFactories
 
SGTechniqueMap mTechniqueEntriesMap
 
String mVertexShaderProfiles
 
StringVector mVertexShaderProfilesList
 
VSOutputCompactPolicy mVSOutputCompactPolicy
 

Static Protected Attributes

static ShaderGeneratorms_Singleton
 

Friends

class FFPRenderStateBuilder
 
class SGMaterialSerializerListener
 
class SGPass
 
class SGScriptTranslator
 
class SGScriptTranslatorManager
 

Detailed Description

Shader generator system main interface.

This singleton based class enables automatic generation of shader code based on existing material techniques.

Definition at line 52 of file OgreShaderGenerator.h.

Member Typedef Documentation

typedef SceneManagerMap::const_iterator Ogre::RTShader::ShaderGenerator::SceneManagerConstIterator
protected

Definition at line 677 of file OgreShaderGenerator.h.

typedef SceneManagerMap::iterator Ogre::RTShader::ShaderGenerator::SceneManagerIterator
protected

Definition at line 676 of file OgreShaderGenerator.h.

Definition at line 675 of file OgreShaderGenerator.h.

typedef SGMaterialMap::const_iterator Ogre::RTShader::ShaderGenerator::SGMaterialConstIterator
protected

Definition at line 362 of file OgreShaderGenerator.h.

typedef SGMaterialMap::iterator Ogre::RTShader::ShaderGenerator::SGMaterialIterator
protected

Definition at line 361 of file OgreShaderGenerator.h.

Definition at line 360 of file OgreShaderGenerator.h.

typedef SGPassList::const_iterator Ogre::RTShader::ShaderGenerator::SGPassConstIterator
protected

Definition at line 351 of file OgreShaderGenerator.h.

typedef SGPassList::iterator Ogre::RTShader::ShaderGenerator::SGPassIterator
protected

Definition at line 350 of file OgreShaderGenerator.h.

Definition at line 347 of file OgreShaderGenerator.h.

typedef SGMaterialMap::const_iterator Ogre::RTShader::ShaderGenerator::SGSchemeConstIterator
protected

Definition at line 366 of file OgreShaderGenerator.h.

typedef SGSchemeMap::iterator Ogre::RTShader::ShaderGenerator::SGSchemeIterator
protected

Definition at line 365 of file OgreShaderGenerator.h.

Definition at line 364 of file OgreShaderGenerator.h.

typedef SGScriptTranslatorMap::const_iterator Ogre::RTShader::ShaderGenerator::SGScriptTranslatorConstIterator
protected

Definition at line 370 of file OgreShaderGenerator.h.

typedef SGScriptTranslatorMap::iterator Ogre::RTShader::ShaderGenerator::SGScriptTranslatorIterator
protected

Definition at line 369 of file OgreShaderGenerator.h.

typedef SGTechniqueList::const_iterator Ogre::RTShader::ShaderGenerator::SGTechniqueConstIterator
protected

Definition at line 355 of file OgreShaderGenerator.h.

typedef SGTechniqueList::iterator Ogre::RTShader::ShaderGenerator::SGTechniqueIterator
protected

Definition at line 354 of file OgreShaderGenerator.h.

Definition at line 353 of file OgreShaderGenerator.h.

typedef SGTechniqueMap::iterator Ogre::RTShader::ShaderGenerator::SGTechniqueMapIterator
protected

Definition at line 358 of file OgreShaderGenerator.h.

typedef SubRenderStateFactoryMap::const_iterator Ogre::RTShader::ShaderGenerator::SubRenderStateFactoryConstIterator
protected

Definition at line 672 of file OgreShaderGenerator.h.

typedef SubRenderStateFactoryMap::iterator Ogre::RTShader::ShaderGenerator::SubRenderStateFactoryIterator
protected

Definition at line 671 of file OgreShaderGenerator.h.

Constructor & Destructor Documentation

Ogre::RTShader::ShaderGenerator::ShaderGenerator ( )
protected

Class default constructor.

Ogre::RTShader::ShaderGenerator::~ShaderGenerator ( )
protected

Class destructor.

Member Function Documentation

void Ogre::RTShader::ShaderGenerator::_finalize ( )
protected

Finalize the shader generator instance.

bool Ogre::RTShader::ShaderGenerator::_initialize ( )
protected

Initialize the shader generator instance.

bool Ogre::RTShader::ShaderGenerator::addCustomScriptTranslator ( const String key,
ScriptTranslator translator 
)
protected

Add custom script translator.

Return true upon success.

Parameters
keyThe key name of the given translator.
translatorThe translator to associate with the given key.
void Ogre::RTShader::ShaderGenerator::addSceneManager ( SceneManager sceneMgr)

Add a scene manager to the shader generator scene managers list.

Parameters
sceneMgrThe scene manager to add to the list.
void Ogre::RTShader::ShaderGenerator::addSubRenderStateFactory ( SubRenderStateFactory factory)

Add sub render state factory.

Plugins or 3d party applications may implement sub classes of SubRenderState interface. Add the matching factory will allow the application to create instances of these sub classes.

Parameters
factoryThe factory to add.
void Ogre::RTShader::ShaderGenerator::createScheme ( const String schemeName)

Create a scheme.

Parameters
schemeNameThe scheme name to create.
bool Ogre::RTShader::ShaderGenerator::createShaderBasedTechnique ( const String materialName,
const String srcTechniqueSchemeName,
const String dstTechniqueSchemeName 
)

Create shader based technique from a given technique.

Return true upon success. Failure may occur if the source technique is not FFP pure, or different source technique is mapped to the requested destination scheme.

Parameters
materialNameThe source material name.
srcTechniqueSchemeNameThe source technique scheme name.
dstTechniqueSchemeNameThe destination shader based technique scheme name.
SubRenderState* Ogre::RTShader::ShaderGenerator::createSubRenderState ( const String type)

Create an instance of sub render state from a given type.

Parameters
typeThe type of sub render state to create.
SubRenderState* Ogre::RTShader::ShaderGenerator::createSubRenderState ( ScriptCompiler compiler,
PropertyAbstractNode prop,
Pass pass 
)
protected

Create an instance of the SubRenderState based on script properties using the current sub render state factories.

See also
SubRenderStateFactory::createInstance
Parameters
compilerThe compiler instance.
propThe abstract property node.
passThe pass that is the parent context of this node.
void Ogre::RTShader::ShaderGenerator::createSubRenderStateExFactories ( )
protected

Create sub render state core extensions factories.

void Ogre::RTShader::ShaderGenerator::destroySubRenderState ( SubRenderState subRenderState)

Destroy an instance of sub render state.

Parameters
subRenderStateThe instance to destroy.
void Ogre::RTShader::ShaderGenerator::destroySubRenderStateExFactories ( )
protected

Destroy sub render state core extensions factories.

static void Ogre::RTShader::ShaderGenerator::finalize ( )
static

Finalize the Shader Generator instance.

Technique* Ogre::RTShader::ShaderGenerator::findSourceTechnique ( const String materialName,
const String srcTechniqueSchemeName 
)
protected

Find source technique to generate shader based technique based on it.

void Ogre::RTShader::ShaderGenerator::flushShaderCache ( )

Flush the shader cache.

This operation will cause all active sachems to be invalidated and will destroy any CPU/GPU program that created by this shader generator.

SceneManager* Ogre::RTShader::ShaderGenerator::getActiveSceneManager ( )

Get the active scene manager that is doint the actual scene rendering.

This attribute will be update on the call to preFindVisibleObjects.

size_t Ogre::RTShader::ShaderGenerator::getFragmentShaderCount ( ) const

Return the current number of generated fragment shaders.

const String& Ogre::RTShader::ShaderGenerator::getFragmentShaderProfiles ( ) const
inline

Get the output fragment shader target profiles.

Definition at line 161 of file OgreShaderGenerator.h.

const StringVector& Ogre::RTShader::ShaderGenerator::getFragmentShaderProfilesList ( ) const
inline

Get the output fragment shader target profiles as list of strings.

Definition at line 166 of file OgreShaderGenerator.h.

SGMaterialSerializerListener* Ogre::RTShader::ShaderGenerator::getMaterialSerializerListener ( )

Return custom material Serializer of the shader generator.

This is useful when you'd like to export certain material that contains shader generator effects. I.E - when writing an exporter you may want mark your material as shader generated material so in the next time you will load it by your application it will automatically generate shaders with custom attributes you wanted. To do it you'll have to do the following steps:

  1. Create shader based technique for you material via the createShaderBasedTechnique() method.
  2. Create MaterialSerializer instance.
  3. Add the return instance of serializer listener to the MaterialSerializer.
  4. Call one of the export methods of MaterialSerializer.
size_t Ogre::RTShader::ShaderGenerator::getNumTranslators ( ) const
protected

Return number of script translators.

RenderState* Ogre::RTShader::ShaderGenerator::getRenderState ( const String schemeName)

Return a global render state associated with the given scheme name.

Modifying this render state will affect all techniques that belongs to that scheme. This is the best way to apply global changes to all techniques. After altering the render state one should call invalidateScheme method in order to regenerate shaders.

Parameters
schemeNameThe destination scheme name.
RenderState* Ogre::RTShader::ShaderGenerator::getRenderState ( const String schemeName,
const String materialName,
unsigned short  passIndex 
)

Get render state of specific pass.

Using this method allows the user to customize the behavior of a specific pass.

Parameters
schemeNameThe destination scheme name.
materialNameThe specific material name.
passIndexThe pass index.
const String& Ogre::RTShader::ShaderGenerator::getShaderCachePath ( ) const
inline

Get the output shader cache path.

Definition at line 179 of file OgreShaderGenerator.h.

static ShaderGenerator& Ogre::RTShader::ShaderGenerator::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 ShaderGenerator* Ogre::RTShader::ShaderGenerator::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.
const String& Ogre::RTShader::ShaderGenerator::getTargetLanguage ( ) const
inline

Return the target shader language currently in use.

Definition at line 133 of file OgreShaderGenerator.h.

ScriptTranslator* Ogre::RTShader::ShaderGenerator::getTranslator ( const AbstractNodePtr node)
protected

Return a matching script translator.

size_t Ogre::RTShader::ShaderGenerator::getVertexShaderCount ( ) const

Return the current number of generated vertex shaders.

VSOutputCompactPolicy Ogre::RTShader::ShaderGenerator::getVertexShaderOutputsCompactPolicy ( ) const
inline

Get the vertex shader outputs compaction policy.

See also
VSOutputCompactPolicy.

Definition at line 337 of file OgreShaderGenerator.h.

const String& Ogre::RTShader::ShaderGenerator::getVertexShaderProfiles ( ) const
inline

Get the output vertex shader target profiles.

Definition at line 144 of file OgreShaderGenerator.h.

const StringVector& Ogre::RTShader::ShaderGenerator::getVertexShaderProfilesList ( ) const
inline

Get the output vertex shader target profiles as list of strings.

Definition at line 149 of file OgreShaderGenerator.h.

static bool Ogre::RTShader::ShaderGenerator::initialize ( )
static

Initialize the Shader Generator System.

Return true upon success.

Parameters
sceneMgrThe scene manager that the shader generator will be bound to.
void Ogre::RTShader::ShaderGenerator::invalidateMaterial ( const String schemeName,
const String materialName 
)

Invalidate specific material scheme.

This action will lead to shader regeneration of the technique belongs to the given scheme name.

Parameters
schemeNameThe scheme to invalidate.
materialNameThe material to invalidate.
void Ogre::RTShader::ShaderGenerator::invalidateScheme ( const String schemeName)

Invalidate a given scheme.

This action will lead to shader regeneration of all techniques belongs to the given scheme name.

Parameters
schemeNameThe scheme to invalidate.
void Ogre::RTShader::ShaderGenerator::notifyRenderSingleObject ( Renderable rend,
const Pass pass,
const AutoParamDataSource source,
const LightList pLightList,
bool  suppressRenderStateChanges 
)
protected

Called from the sub class of the RenderObjectLister when single object is rendered.

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

Definition at line 95 of file OgreMemoryAllocatedObject.h.

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.

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

Definition at line 118 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 67 of file OgreMemoryAllocatedObject.h.

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

Definition at line 72 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 78 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 85 of file OgreMemoryAllocatedObject.h.

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

void Ogre::RTShader::ShaderGenerator::preFindVisibleObjects ( SceneManager source,
SceneManager::IlluminationRenderStage  irs,
Viewport v 
)
protected

Called from the sub class of the SceneManager::Listener when finding visible object process starts.

bool Ogre::RTShader::ShaderGenerator::removeAllShaderBasedTechniques ( const String materialName)

Remove all shader based techniques of the given material.

Return true upon success.

Parameters
materialNameThe source material name.
void Ogre::RTShader::ShaderGenerator::removeAllShaderBasedTechniques ( )

Remove all shader based techniques that created by this shader generator.

bool Ogre::RTShader::ShaderGenerator::removeCustomScriptTranslator ( const String key)
protected

Remove custom script translator.

Return true upon success.

Parameters
keyThe key name of the translator to remove.
void Ogre::RTShader::ShaderGenerator::removeSceneManager ( SceneManager sceneMgr)

Remove a scene manager from the shader generator scene managers list.

Parameters
sceneMgrThe scene manager to remove from the list.
bool Ogre::RTShader::ShaderGenerator::removeShaderBasedTechnique ( const String materialName,
const String srcTechniqueSchemeName,
const String dstTechniqueSchemeName 
)

Remove shader based technique from a given technique.

Return true upon success. Failure may occur if the given source technique was not previously registered successfully using the createShaderBasedTechnique method.

Parameters
materialNameThe source material name.
srcTechniqueSchemeNameThe source technique scheme name.
dstTechniqueSchemeNameThe destination shader based technique scheme name.
void Ogre::RTShader::ShaderGenerator::removeSubRenderStateFactory ( SubRenderStateFactory factory)

Remove sub render state factory.

Parameters
factoryThe factory to remove.
void Ogre::RTShader::ShaderGenerator::serializePassAttributes ( MaterialSerializer ser,
SGPass passEntry 
)
protected

This method called by instance of SGMaterialSerializerListener and serialize a given pass entry attributes.

Parameters
serThe material serializer.
passEntryThe SGPass instance.
void Ogre::RTShader::ShaderGenerator::setFragmentShaderProfiles ( const String fragmentShaderProfiles)

Set the output fragment shader target profiles.

Parameters
fragmentShaderProfileThe target profiles for the fragment shader.
void Ogre::RTShader::ShaderGenerator::setShaderCachePath ( const String cachePath)

Set the output shader cache path.

Generated shader code will be written to this path. In case of empty cache path shaders will be generated directly from system memory.

Parameters
cachePathThe cache path of the shader. The default is empty cache path.
void Ogre::RTShader::ShaderGenerator::setTargetLanguage ( const String shaderLanguage)

Set the target shader language.

Parameters
shaderLanguageThe output shader language to use.
Remarks
The default shader language is cg.
void Ogre::RTShader::ShaderGenerator::setVertexShaderOutputsCompactPolicy ( VSOutputCompactPolicy  policy)
inline

Set the vertex shader outputs compaction policy.

See also
VSOutputCompactPolicy.
Parameters
policyThe policy to set.

Definition at line 332 of file OgreShaderGenerator.h.

void Ogre::RTShader::ShaderGenerator::setVertexShaderProfiles ( const String vertexShaderProfiles)

Set the output vertex shader target profiles.

Parameters
vertexShaderProfileThe target profiles for the vertex shader.
bool Ogre::RTShader::ShaderGenerator::validateMaterial ( const String schemeName,
const String materialName 
)

Validate specific material scheme.

This action will generate shader programs for the technique of the given scheme name.

Parameters
schemeNameThe scheme to validate.
materialNameThe material to validate.
bool Ogre::RTShader::ShaderGenerator::validateScheme ( const String schemeName)

Validate a given scheme.

This action will generate shader programs for all techniques of the given scheme name.

Parameters
schemeNameThe scheme to validate.

Friends And Related Function Documentation

friend class FFPRenderStateBuilder
friend

Definition at line 777 of file OgreShaderGenerator.h.

friend class SGMaterialSerializerListener
friend

Definition at line 780 of file OgreShaderGenerator.h.

friend class SGPass
friend

Definition at line 776 of file OgreShaderGenerator.h.

friend class SGScriptTranslator
friend

Definition at line 779 of file OgreShaderGenerator.h.

friend class SGScriptTranslatorManager
friend

Definition at line 778 of file OgreShaderGenerator.h.

Member Data Documentation

String Ogre::RTShader::ShaderGenerator::DEFAULT_SCHEME_NAME
static

Default material scheme of the shader generator.

Definition at line 340 of file OgreShaderGenerator.h.

OGRE_AUTO_MUTEX SceneManager* Ogre::RTShader::ShaderGenerator::mActiveSceneMgr
protected

Definition at line 749 of file OgreShaderGenerator.h.

bool Ogre::RTShader::ShaderGenerator::mActiveViewportValid
protected

Definition at line 771 of file OgreShaderGenerator.h.

SGScriptTranslator Ogre::RTShader::ShaderGenerator::mCoreScriptTranslator
protected

Definition at line 756 of file OgreShaderGenerator.h.

FFPRenderStateBuilder* Ogre::RTShader::ShaderGenerator::mFFPRenderStateBuilder
protected

Definition at line 765 of file OgreShaderGenerator.h.

String Ogre::RTShader::ShaderGenerator::mFragmentShaderProfiles
protected

Definition at line 760 of file OgreShaderGenerator.h.

StringVector Ogre::RTShader::ShaderGenerator::mFragmentShaderProfilesList
protected

Definition at line 761 of file OgreShaderGenerator.h.

int Ogre::RTShader::ShaderGenerator::mLightCount[3]
protected

Definition at line 772 of file OgreShaderGenerator.h.

SGMaterialMap Ogre::RTShader::ShaderGenerator::mMaterialEntriesMap
protected

Definition at line 766 of file OgreShaderGenerator.h.

SGMaterialSerializerListener* Ogre::RTShader::ShaderGenerator::mMaterialSerializerListener
protected

Definition at line 754 of file OgreShaderGenerator.h.

ProgramManager* Ogre::RTShader::ShaderGenerator::mProgramManager
protected

Definition at line 763 of file OgreShaderGenerator.h.

ProgramWriterManager* Ogre::RTShader::ShaderGenerator::mProgramWriterManager
protected

Definition at line 764 of file OgreShaderGenerator.h.

SGRenderObjectListener* Ogre::RTShader::ShaderGenerator::mRenderObjectListener
protected

Definition at line 751 of file OgreShaderGenerator.h.

ShaderGenerator * Ogre::Singleton< ShaderGenerator >::ms_Singleton
staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.

SGSceneManagerListener* Ogre::RTShader::ShaderGenerator::mSceneManagerListener
protected

Definition at line 752 of file OgreShaderGenerator.h.

SceneManagerMap Ogre::RTShader::ShaderGenerator::mSceneManagerMap
protected

Definition at line 750 of file OgreShaderGenerator.h.

SGSchemeMap Ogre::RTShader::ShaderGenerator::mSchemeEntriesMap
protected

Definition at line 767 of file OgreShaderGenerator.h.

SGScriptTranslatorManager* Ogre::RTShader::ShaderGenerator::mScriptTranslatorManager
protected

Definition at line 753 of file OgreShaderGenerator.h.

SGScriptTranslatorMap Ogre::RTShader::ShaderGenerator::mScriptTranslatorsMap
protected

Definition at line 755 of file OgreShaderGenerator.h.

String Ogre::RTShader::ShaderGenerator::mShaderCachePath
protected

Definition at line 762 of file OgreShaderGenerator.h.

String Ogre::RTShader::ShaderGenerator::mShaderLanguage
protected

Definition at line 757 of file OgreShaderGenerator.h.

SubRenderStateFactoryMap Ogre::RTShader::ShaderGenerator::mSubRenderStateExFactories
protected

Definition at line 770 of file OgreShaderGenerator.h.

SubRenderStateFactoryMap Ogre::RTShader::ShaderGenerator::mSubRenderStateFactories
protected

Definition at line 769 of file OgreShaderGenerator.h.

SGTechniqueMap Ogre::RTShader::ShaderGenerator::mTechniqueEntriesMap
protected

Definition at line 768 of file OgreShaderGenerator.h.

String Ogre::RTShader::ShaderGenerator::mVertexShaderProfiles
protected

Definition at line 758 of file OgreShaderGenerator.h.

StringVector Ogre::RTShader::ShaderGenerator::mVertexShaderProfilesList
protected

Definition at line 759 of file OgreShaderGenerator.h.

VSOutputCompactPolicy Ogre::RTShader::ShaderGenerator::mVSOutputCompactPolicy
protected

Definition at line 773 of file OgreShaderGenerator.h.


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