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>

Collaboration diagram for Ogre::RTShader::SubRenderStateAccessor:

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

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

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 175 of file OgreShaderSubRenderState.h.

Constructor & Destructor Documentation

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

inlineprotected

Construct SubRenderState accessor based on the given template SubRenderState.

Definition at line 206 of file OgreShaderSubRenderState.h.

Member Function Documentation

void Ogre::RTShader::SubRenderStateAccessor::addSubRenderStateInstance ( SubRenderState *  subRenderState ) const

inline

Add SubRenderState instance to this accessor.

Definition at line 180 of file OgreShaderSubRenderState.h.

SubRenderStateSet& Ogre::RTShader::SubRenderStateAccessor::getSubRenderStateInstanceSet ( )

inline

Return a set of all instances of the template SubRenderState.

Definition at line 198 of file OgreShaderSubRenderState.h.

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

inline

Return a set of all instances of the template SubRenderState.

(const version).

Definition at line 201 of file OgreShaderSubRenderState.h.

void Ogre::RTShader::SubRenderStateAccessor::removeSubRenderStateInstance ( SubRenderState *  subRenderState ) const

inline

Remove SubRenderState instance to this accessor.

Definition at line 187 of file OgreShaderSubRenderState.h.

Friends And Related Function Documentation

friend class SubRenderState

friend

Definition at line 214 of file OgreShaderSubRenderState.h.

Member Data Documentation

SubRenderStateSet Ogre::RTShader::SubRenderStateAccessor::mSubRenderStateInstancesSet

mutableprotected

Definition at line 211 of file OgreShaderSubRenderState.h.

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

protected

Definition at line 210 of file OgreShaderSubRenderState.h.

---

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

• OgreShaderSubRenderState.h