Ogre::RTShader::SubRenderStateAccessor Class Reference

This class uses as accessor from a template SubRenderState to all of its instances that created based on it. More...

#include <OgreShaderSubRenderState.h>

Public Member Functions
void	addSubRenderStateInstance (SubRenderState *subRenderState) const
	Add SubRenderState instance to this accessor.
SubRenderStateSet &	getSubRenderStateInstanceSet ()
	Return a set of all instances of the template SubRenderState.
const SubRenderStateSet &	getSubRenderStateInstanceSet () const
	Return a set of all instances of the template SubRenderState.
void	removeSubRenderStateInstance (SubRenderState *subRenderState) const
	Remove SubRenderState instance to this accessor.

Protected Member Functions
	SubRenderStateAccessor (const SubRenderState *templateSubRenderState)
	Construct SubRenderState accessor based on the given template SubRenderState.

Protected Attributes
SubRenderStateSet	mSubRenderStateInstancesSet
const SubRenderState *	mTemplateSubRenderState

Friends
class	SubRenderState

Detailed Description

This class uses as accessor from a template SubRenderState to all of its instances that created based on it.

Since SubRenderState that added as templates to a RenderState are not directly used by the system this class enable accessing the used instances. A common usage will be add a SubRenderState to certain pass, obtain accessor and then call a method on the instanced SubRenderState that will trigger some GPU uniform parameter updates.

Definition at line 177 of file OgreShaderSubRenderState.h.

Constructor & Destructor Documentation

SubRenderStateAccessor()

Ogre::RTShader::SubRenderStateAccessor::SubRenderStateAccessor ( const SubRenderState * templateSubRenderState )

protected

Construct SubRenderState accessor based on the given template SubRenderState.

Definition at line 208 of file OgreShaderSubRenderState.h.

References mTemplateSubRenderState, and SubRenderState.

Member Function Documentation

addSubRenderStateInstance()

void Ogre::RTShader::SubRenderStateAccessor::addSubRenderStateInstance

(

SubRenderState *

subRenderState

)

const

Add SubRenderState instance to this accessor.

Definition at line 182 of file OgreShaderSubRenderState.h.

References mSubRenderStateInstancesSet, and SubRenderState.

getSubRenderStateInstanceSet() [1/2]

SubRenderStateSet & Ogre::RTShader::SubRenderStateAccessor::getSubRenderStateInstanceSet

(

)

Return a set of all instances of the template SubRenderState.

Definition at line 200 of file OgreShaderSubRenderState.h.

References mSubRenderStateInstancesSet.

getSubRenderStateInstanceSet() [2/2]

const SubRenderStateSet & Ogre::RTShader::SubRenderStateAccessor::getSubRenderStateInstanceSet

(

)

const

Return a set of all instances of the template SubRenderState.

(const version).

Definition at line 203 of file OgreShaderSubRenderState.h.

References mSubRenderStateInstancesSet.

removeSubRenderStateInstance()

void Ogre::RTShader::SubRenderStateAccessor::removeSubRenderStateInstance

(

SubRenderState *

subRenderState

)

const

Remove SubRenderState instance to this accessor.

Definition at line 189 of file OgreShaderSubRenderState.h.

References mSubRenderStateInstancesSet, and SubRenderState.

Friends And Related Symbol Documentation

SubRenderState

friend class SubRenderState

friend

Definition at line 216 of file OgreShaderSubRenderState.h.

References SubRenderState.

Referenced by SubRenderStateAccessor(), addSubRenderStateInstance(), removeSubRenderStateInstance(), and SubRenderState.

Member Data Documentation

mSubRenderStateInstancesSet

SubRenderStateSet Ogre::RTShader::SubRenderStateAccessor::mSubRenderStateInstancesSet

mutableprotected

Definition at line 213 of file OgreShaderSubRenderState.h.

Referenced by addSubRenderStateInstance(), getSubRenderStateInstanceSet(), getSubRenderStateInstanceSet(), and removeSubRenderStateInstance().

mTemplateSubRenderState

const SubRenderState* Ogre::RTShader::SubRenderStateAccessor::mTemplateSubRenderState

protected

Definition at line 212 of file OgreShaderSubRenderState.h.

Referenced by SubRenderStateAccessor().

---

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

• OgreShaderSubRenderState.h