OGRE  13.0
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::WBOITFactory Class Reference

A factory that enables creation of GBuffer instances. More...

#include <OgreShaderExWBOIT.h>

+ Inheritance diagram for Ogre::RTShader::WBOITFactory:

Public Member Functions

SubRenderStatecreateInstance (ScriptCompiler *compiler, PropertyAbstractNode *prop, Pass *pass, SGScriptTranslator *translator) override
 Create an instance of the SubRenderState based on script properties. More...
 
const StringgetType () const override
 Get the type of this sub render state factory. More...
 
void writeInstance (MaterialSerializer *ser, SubRenderState *subRenderState, Pass *srcPass, Pass *dstPass) override
 Write the given sub-render state instance using the material serializer. More...
 
- Public Member Functions inherited from Ogre::RTShader::SubRenderStateFactory
 SubRenderStateFactory ()
 
virtual ~SubRenderStateFactory ()
 
virtual SubRenderStatecreateInstance ()
 Create an instance of the SubRenderState sub class it suppose to create. More...
 
virtual SubRenderStatecreateInstance (ScriptCompiler *compiler, PropertyAbstractNode *prop, TextureUnitState *texState, SGScriptTranslator *translator)
 Create an instance of the SubRenderState based on script properties. More...
 
virtual SubRenderStatecreateOrRetrieveInstance (SGScriptTranslator *translator)
 Retrieve the previous instance the SRS in the script translator or create a new instance if not found. More...
 
virtual void destroyAllInstances ()
 Destroy all the instances that created by this factory. More...
 
virtual void destroyInstance (SubRenderState *subRenderState)
 Destroy the given instance. More...
 
virtual void writeInstance (MaterialSerializer *ser, SubRenderState *subRenderState, const TextureUnitState *srcTextureUnit, const TextureUnitState *dstTextureUnit)
 Write the given sub-render state instance using the material serializer. More...
 

Detailed Description

A factory that enables creation of GBuffer instances.

Remarks
Sub class of SubRenderStateFactory

Member Function Documentation

◆ getType()

const String& Ogre::RTShader::WBOITFactory::getType ( ) const
overridevirtual

Get the type of this sub render state factory.

Remarks
The type string should be the same as the type of the SubRenderState sub class it is going to create.
See also
SubRenderState::getType.

Implements Ogre::RTShader::SubRenderStateFactory.

◆ createInstance()

SubRenderState* Ogre::RTShader::WBOITFactory::createInstance ( ScriptCompiler compiler,
PropertyAbstractNode prop,
Pass pass,
SGScriptTranslator translator 
)
overridevirtual

Create an instance of the SubRenderState based on script properties.


This method is called in the context of script parsing and let this factory the opportunity to create custom SubRenderState instances based on extended script properties.

Parameters
compilerThe compiler instance.
propThe abstract property node.
passThe pass that is the parent context of this node.
translatorThe translator instance holding existing scripts.

Reimplemented from Ogre::RTShader::SubRenderStateFactory.

◆ writeInstance()

void Ogre::RTShader::WBOITFactory::writeInstance ( MaterialSerializer ser,
SubRenderState subRenderState,
Pass srcPass,
Pass dstPass 
)
overridevirtual

Write the given sub-render state instance using the material serializer.

This method is called in the context of material serialization. It is useful for integrating into bigger context of material exporters from various environment that want to take advantage of the RT Shader System. Sub classes of this interface should override in case they need to write custom properties into the script context.

Parameters
serThe material serializer instance.
subRenderStateThe sub render state instance to write down.
srcPassThe source pass.
dstPassThe generated shader based pass.

Reimplemented from Ogre::RTShader::SubRenderStateFactory.


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