OGRE  1.12.7
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::ShaderGenerator Class Reference

Shader generator system main interface. More...

#include <OgreShaderGenerator.h>

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

Public Types

typedef std::pair< RenderState *, bool > RenderStateCreateOrRetrieveResult
 

Public Member Functions

void _setActiveSceneManager (SceneManager *sceneManager)
 Set the active scene manager against which new render states are compiled. More...
 
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...
 
bool cloneShaderBasedTechniques (const String &srcMaterialName, const String &srcGroupName, const String &dstMaterialName, const String &dstGroupName)
 Clone all shader based techniques from one material to another. More...
 
RenderStateCreateOrRetrieveResult createOrRetrieveRenderState (const String &schemeName)
 Returns a requested render state. More...
 
void createScheme (const String &schemeName)
 Create a scheme. More...
 
bool createShaderBasedTechnique (const Material &srcMat, const String &srcTechniqueSchemeName, const String &dstTechniqueSchemeName, bool overProgrammable=false)
 Create shader based technique from a given technique. More...
 
bool createShaderBasedTechnique (const Technique *srcTech, const String &dstTechniqueSchemeName, bool overProgrammable=false)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
template<typename T >
T * createSubRenderState ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 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...
 
bool getCreateShaderOverProgrammablePass () const
 Returns whether shaders are created for passes with shaders. More...
 
MaterialSerializer::ListenergetMaterialSerializerListener ()
 Return custom material Serializer of the shader generator. More...
 
size_t getNumSubRenderStateFactories () const
 Returns the number of existing factories. More...
 
RenderStategetRenderState (const String &schemeName)
 Return a global render state associated with the given scheme name. More...
 
RenderStategetRenderState (const String &schemeName, const String &materialName, const String &groupName, unsigned short passIndex)
 Get render state of specific pass. More...
 
const StringgetRTShaderScheme (size_t index) const
 Returns the scheme name used in the for RT shader generation by index. More...
 
size_t getRTShaderSchemeCount () const
 Returns the amount of schemes used in the for RT shader generation. More...
 
const StringgetShaderCachePath () const
 Get the output shader cache path. More...
 
size_t getShaderCount (GpuProgramType type) const
 Return the current number of generated shaders. More...
 
const StringgetShaderProfiles (GpuProgramType type) const
 Get the output shader target profiles. More...
 
const StringVectorgetShaderProfilesList (GpuProgramType type)
 Get the output shader target profiles as list of strings. More...
 
SubRenderStateFactorygetSubRenderStateFactory (const String &type)
 Returns a sub render state factory by name. More...
 
SubRenderStateFactorygetSubRenderStateFactory (size_t index)
 Returns a sub render state factory by index. More...
 
const StringgetTargetLanguage () const
 Return the target shader language currently in use. More...
 
VSOutputCompactPolicy getVertexShaderOutputsCompactPolicy () const
 Get the vertex shader outputs compaction policy. More...
 
bool hasRenderState (const String &schemeName) const
 Tells if a given render state exists. More...
 
bool hasShaderBasedTechnique (const String &materialName, const String &groupName, const String &srcTechniqueSchemeName, const String &dstTechniqueSchemeName) const
 Checks if a shader based technique has been created for a given technique. More...
 
bool hasShaderBasedTechnique (const String &materialName, const String &srcTechniqueSchemeName, const String &dstTechniqueSchemeName) const
 Checks if a shader based technique has been created for a given technique. More...
 
void invalidateMaterial (const String &schemeName, const String &materialName, const String &groupName=RGN_DEFAULT)
 Invalidate specific material scheme. More...
 
void invalidateMaterialIlluminationPasses (const String &schemeName, const String &materialName, const String &groupName=RGN_DEFAULT)
 Invalidate specific material scheme. More...
 
void invalidateScheme (const String &schemeName)
 Invalidate a given scheme. More...
 
void removeAllShaderBasedTechniques ()
 Remove all shader based techniques that created by this shader generator. More...
 
bool removeAllShaderBasedTechniques (const String &materialName, const String &groupName=RGN_DEFAULT)
 Remove all shader based techniques of the given material. More...
 
void removeSceneManager (SceneManager *sceneMgr)
 Remove a scene manager from the shader generator scene managers list. More...
 
bool removeShaderBasedTechnique (const Technique *srcTech, const String &dstTechniqueSchemeName)
 Remove shader based technique from a given technique. More...
 
void removeSubRenderStateFactory (SubRenderStateFactory *factory)
 Remove sub render state factory. More...
 
void setCreateShaderOverProgrammablePass (bool value)
 Sets whether shaders are created for passes with shaders. More...
 
void setShaderCachePath (const String &cachePath)
 Set the output shader cache path. More...
 
void setShaderProfiles (GpuProgramType type, const String &shaderProfiles)
 Set the output shader target profiles. More...
 
void setTargetLanguage (const String &shaderLanguage)
 Set the target shader language. More...
 
void setVertexShaderOutputsCompactPolicy (VSOutputCompactPolicy policy)
 Set the vertex shader outputs compaction policy. More...
 
bool validateMaterial (const String &schemeName, const String &materialName, const String &groupName=RGN_DEFAULT)
 Validate specific material scheme. More...
 
bool validateMaterialIlluminationPasses (const String &schemeName, const String &materialName, const String &groupName=RGN_DEFAULT)
 Validate specific material scheme. More...
 
bool validateScheme (const String &schemeName)
 Validate a given scheme. More...
 
- Public Member Functions inherited from Ogre::Singleton< ShaderGenerator >
 Singleton (void)
 
 ~Singleton (void)
 

Static Public Member Functions

static void destroy ()
 Destroy the Shader Generator instance. More...
 
static ShaderGeneratorgetSingleton ()
 Override standard Singleton retrieval. More...
 
static ShaderGeneratorgetSingletonPtr ()
 Get the singleton instance. More...
 
static bool initialize ()
 Initialize the Shader Generator System. More...
 
- Static Public Member Functions inherited from Ogre::Singleton< ShaderGenerator >
static ShaderGeneratorgetSingleton (void)
 Get the singleton instance. More...
 
static ShaderGeneratorgetSingletonPtr (void)
 Get the singleton instance. More...
 

Static Public Attributes

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

Friends

class FFPRenderStateBuilder
 
class SGMaterialSerializerListener
 
class SGPass
 
class SGRenderObjectListener
 
class SGSceneManagerListener
 
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.

Member Typedef Documentation

◆ RenderStateCreateOrRetrieveResult

Member Function Documentation

◆ initialize()

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

Initialize the Shader Generator System.

Return true upon success.

◆ destroy()

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

Destroy the Shader Generator instance.

◆ getSingleton()

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.

◆ getSingletonPtr()

static ShaderGenerator* Ogre::RTShader::ShaderGenerator::getSingletonPtr ( )
static

Get the singleton instance.

◆ addSceneManager()

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.

◆ removeSceneManager()

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.

◆ getActiveSceneManager()

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.

◆ _setActiveSceneManager()

void Ogre::RTShader::ShaderGenerator::_setActiveSceneManager ( SceneManager sceneManager)

Set the active scene manager against which new render states are compiled.

Note that normally the setting of the active scene manager is updated through the preFindVisibleObjects method.

◆ setTargetLanguage()

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.

◆ getTargetLanguage()

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

Return the target shader language currently in use.


◆ setShaderProfiles()

void Ogre::RTShader::ShaderGenerator::setShaderProfiles ( GpuProgramType  type,
const String shaderProfiles 
)

Set the output shader target profiles.

Parameters
typeshader type
shaderProfilesThe target profiles for the shader.

◆ getShaderProfiles()

const String& Ogre::RTShader::ShaderGenerator::getShaderProfiles ( GpuProgramType  type) const

Get the output shader target profiles.

◆ getShaderProfilesList()

const StringVector& Ogre::RTShader::ShaderGenerator::getShaderProfilesList ( GpuProgramType  type)

Get the output shader target profiles as list of strings.

◆ setShaderCachePath()

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.

◆ getShaderCachePath()

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

Get the output shader cache path.

◆ flushShaderCache()

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.

◆ getRenderState() [1/2]

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.

◆ createOrRetrieveRenderState()

RenderStateCreateOrRetrieveResult Ogre::RTShader::ShaderGenerator::createOrRetrieveRenderState ( const String schemeName)

Returns a requested render state.

If the render state does not exist this function creates it.

Parameters
schemeNameThe scheme name to retrieve.

◆ hasRenderState()

bool Ogre::RTShader::ShaderGenerator::hasRenderState ( const String schemeName) const

Tells if a given render state exists.

Parameters
schemeNameThe scheme name to check.

◆ getRenderState() [2/2]

RenderState* Ogre::RTShader::ShaderGenerator::getRenderState ( const String schemeName,
const String materialName,
const String groupName,
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.
groupNameThe specific material name.
passIndexThe pass index.

◆ addSubRenderStateFactory()

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.

◆ getNumSubRenderStateFactories()

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

Returns the number of existing factories.

◆ getSubRenderStateFactory() [1/2]

SubRenderStateFactory* Ogre::RTShader::ShaderGenerator::getSubRenderStateFactory ( size_t  index)

Returns a sub render state factory by index.

Note
index must be lower than the value returned by getNumSubRenderStateFactories()

◆ getSubRenderStateFactory() [2/2]

SubRenderStateFactory* Ogre::RTShader::ShaderGenerator::getSubRenderStateFactory ( const String type)

Returns a sub render state factory by name.

◆ removeSubRenderStateFactory()

void Ogre::RTShader::ShaderGenerator::removeSubRenderStateFactory ( SubRenderStateFactory factory)

Remove sub render state factory.

Parameters
factoryThe factory to remove.

◆ createSubRenderState() [1/2]

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.

◆ createSubRenderState() [2/2]

template<typename T >
T* Ogre::RTShader::ShaderGenerator::createSubRenderState ( )
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ destroySubRenderState()

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

Destroy an instance of sub render state.

Parameters
subRenderStateThe instance to destroy.

◆ hasShaderBasedTechnique() [1/2]

bool Ogre::RTShader::ShaderGenerator::hasShaderBasedTechnique ( const String materialName,
const String srcTechniqueSchemeName,
const String dstTechniqueSchemeName 
) const

Checks if a shader based technique has been created for a given technique.

Return true if exist. False if not.

Parameters
materialNameThe source material name.
srcTechniqueSchemeNameThe source technique scheme name.
dstTechniqueSchemeNameThe destination shader based technique scheme name.

◆ hasShaderBasedTechnique() [2/2]

bool Ogre::RTShader::ShaderGenerator::hasShaderBasedTechnique ( const String materialName,
const String groupName,
const String srcTechniqueSchemeName,
const String dstTechniqueSchemeName 
) const

Checks if a shader based technique has been created for a given technique.

Return true if exist. False if not.

Parameters
materialNameThe source material name.
groupNameThe source group name.
srcTechniqueSchemeNameThe source technique scheme name.
dstTechniqueSchemeNameThe destination shader based technique scheme name.

◆ createShaderBasedTechnique() [1/2]

bool Ogre::RTShader::ShaderGenerator::createShaderBasedTechnique ( const Material srcMat,
const String srcTechniqueSchemeName,
const String dstTechniqueSchemeName,
bool  overProgrammable = false 
)

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
srcMatThe source material.
srcTechniqueSchemeNameThe source technique scheme name.
dstTechniqueSchemeNameThe destination shader based technique scheme name.
overProgrammableIf true a shader will be created even if the pass already has shaders

◆ createShaderBasedTechnique() [2/2]

bool Ogre::RTShader::ShaderGenerator::createShaderBasedTechnique ( const Technique srcTech,
const String dstTechniqueSchemeName,
bool  overProgrammable = false 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ removeShaderBasedTechnique()

bool Ogre::RTShader::ShaderGenerator::removeShaderBasedTechnique ( const Technique srcTech,
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
srcTechThe source technique.
dstTechniqueSchemeNameThe destination shader based technique scheme name.

◆ removeAllShaderBasedTechniques() [1/2]

bool Ogre::RTShader::ShaderGenerator::removeAllShaderBasedTechniques ( const String materialName,
const String groupName = RGN_DEFAULT 
)

Remove all shader based techniques of the given material.

Return true upon success.

Parameters
materialNameThe source material name.
groupNameThe source group name.

◆ cloneShaderBasedTechniques()

bool Ogre::RTShader::ShaderGenerator::cloneShaderBasedTechniques ( const String srcMaterialName,
const String srcGroupName,
const String dstMaterialName,
const String dstGroupName 
)

Clone all shader based techniques from one material to another.

This function can be used in conjunction with the Material::clone() function to copy both material properties and RTSS state from one material to another.

Parameters
srcMaterialNameThe source material name.
srcGroupNameThe source group name.
dstMaterialNameThe destination material name.
dstGroupNameThe destination group name.
Returns
True if successful

◆ removeAllShaderBasedTechniques() [2/2]

void Ogre::RTShader::ShaderGenerator::removeAllShaderBasedTechniques ( )

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


◆ createScheme()

void Ogre::RTShader::ShaderGenerator::createScheme ( const String schemeName)

Create a scheme.

Parameters
schemeNameThe scheme name to create.

◆ invalidateScheme()

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.

◆ validateScheme()

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.

◆ invalidateMaterial()

void Ogre::RTShader::ShaderGenerator::invalidateMaterial ( const String schemeName,
const String materialName,
const String groupName = RGN_DEFAULT 
)

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.
groupNameThe source group name.

◆ validateMaterial()

bool Ogre::RTShader::ShaderGenerator::validateMaterial ( const String schemeName,
const String materialName,
const String groupName = RGN_DEFAULT 
)

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.
groupNameThe source group name.

◆ invalidateMaterialIlluminationPasses()

void Ogre::RTShader::ShaderGenerator::invalidateMaterialIlluminationPasses ( const String schemeName,
const String materialName,
const String groupName = RGN_DEFAULT 
)

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.
groupNameThe source group name.

◆ validateMaterialIlluminationPasses()

bool Ogre::RTShader::ShaderGenerator::validateMaterialIlluminationPasses ( const String schemeName,
const String materialName,
const String groupName = RGN_DEFAULT 
)

Validate specific material scheme.

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

Parameters
schemeNameThe scheme to validate.
materialNameThe material to validate.
groupNameThe source group name.

◆ getMaterialSerializerListener()

MaterialSerializer::Listener* 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.

◆ getShaderCount()

size_t Ogre::RTShader::ShaderGenerator::getShaderCount ( GpuProgramType  type) const

Return the current number of generated shaders.

◆ setVertexShaderOutputsCompactPolicy()

void Ogre::RTShader::ShaderGenerator::setVertexShaderOutputsCompactPolicy ( VSOutputCompactPolicy  policy)
inline

Set the vertex shader outputs compaction policy.

See also
VSOutputCompactPolicy.
Parameters
policyThe policy to set.

◆ getVertexShaderOutputsCompactPolicy()

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

Get the vertex shader outputs compaction policy.

See also
VSOutputCompactPolicy.

◆ setCreateShaderOverProgrammablePass()

void Ogre::RTShader::ShaderGenerator::setCreateShaderOverProgrammablePass ( bool  value)
inline

Sets whether shaders are created for passes with shaders.

Note that this only refers to when the system parses the materials itself. Not for when calling the createShaderBasedTechnique() function directly

Parameters
valueThe value to set this attribute pass.

◆ getCreateShaderOverProgrammablePass()

bool Ogre::RTShader::ShaderGenerator::getCreateShaderOverProgrammablePass ( ) const
inline

Returns whether shaders are created for passes with shaders.

See also
setCreateShaderOverProgrammablePass().

◆ getRTShaderSchemeCount()

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

Returns the amount of schemes used in the for RT shader generation.

◆ getRTShaderScheme()

const String& Ogre::RTShader::ShaderGenerator::getRTShaderScheme ( size_t  index) const

Returns the scheme name used in the for RT shader generation by index.

Friends And Related Function Documentation

◆ SGRenderObjectListener

friend class SGRenderObjectListener
friend

◆ SGSceneManagerListener

friend class SGSceneManagerListener
friend

◆ SGPass

friend class SGPass
friend

◆ FFPRenderStateBuilder

friend class FFPRenderStateBuilder
friend

◆ SGScriptTranslatorManager

friend class SGScriptTranslatorManager
friend

◆ SGScriptTranslator

friend class SGScriptTranslator
friend

◆ SGMaterialSerializerListener

friend class SGMaterialSerializerListener
friend

Member Data Documentation

◆ DEFAULT_SCHEME_NAME

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

Default material scheme of the shader generator.


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