Ogre::RTShader::SubRenderState Class Reference

This class is the base interface of sub part from a shader based rendering pipeline. More...

#include <OgreShaderSubRenderState.h>

Inheritance diagram for Ogre::RTShader::SubRenderState:

Public Member Functions
	SubRenderState ()
	Class default constructor. More...
virtual	~SubRenderState ()
	Class destructor. More...
virtual void	copyFrom (const SubRenderState &rhs)=0
	Copy details from a given sub render state to this one. More...
virtual bool	createCpuSubPrograms (ProgramSet *programSet)
	Create sub programs that represents this sub render state as part of a program set. More...
SubRenderStateAccessorPtr	getAccessor ()
	Return the accessor object to this sub render state. More...
SubRenderStateAccessorPtr	getAccessor () const
	Return the accessor object to this sub render state. More...
virtual int	getExecutionOrder () const =0
	Get the execution order of this sub render state. More...
virtual const String &	getType () const =0
	Get the type of this sub render state. More...
SubRenderState &	operator= (const SubRenderState &rhs)
	Operator = declaration. More...
virtual bool	preAddToRenderState (const RenderState *renderState, Pass *srcPass, Pass *dstPass)
	Called before adding this sub render state to the given render state. More...
virtual void	updateGpuProgramsParams (Renderable *rend, Pass *pass, const AutoParamDataSource *source, const LightList *pLightList)
	Update GPU programs parameters before a rendering operation occurs. More...

Detailed Description

This class is the base interface of sub part from a shader based rendering pipeline.

All sub parts implementations should derive from it and implement the needed methods. A simple example of sub class of this interface will be the transform sub state of the fixed pipeline.

Constructor & Destructor Documentation

SubRenderState()

Ogre::RTShader::SubRenderState::SubRenderState

(

)

Class default constructor.

~SubRenderState()

virtual Ogre::RTShader::SubRenderState::~SubRenderState ( )

virtual

Class destructor.

Member Function Documentation

getType()

virtual const String& Ogre::RTShader::SubRenderState::getType ( ) const

pure virtual

Get the type of this sub render state.

Remarks

The type string should be unique among all registered sub render states.

Implemented in Ogre::RTShader::TriplanarTexturing, Ogre::RTShader::TextureAtlasSampler, Ogre::RTShader::LayeredBlending, Ogre::RTShader::HardwareSkinning, Ogre::RTShader::FFPAlphaTest, Ogre::RTShader::FFPColour, Ogre::RTShader::PerPixelLighting, Ogre::RTShader::FFPFog, Ogre::RTShader::IntegratedPSSM3, Ogre::RTShader::FFPTexturing, Ogre::RTShader::NormalMapLighting, Ogre::RTShader::FFPLighting, and Ogre::RTShader::FFPTransform.

getExecutionOrder()

virtual int Ogre::RTShader::SubRenderState::getExecutionOrder ( ) const

pure virtual

Get the execution order of this sub render state.

Remarks

The return value should be synchronized with the predefined values of the FFPShaderStage enum.

Implemented in Ogre::RTShader::TriplanarTexturing, Ogre::RTShader::TextureAtlasSampler, Ogre::RTShader::HardwareSkinning, Ogre::RTShader::FFPAlphaTest, Ogre::RTShader::FFPColour, Ogre::RTShader::PerPixelLighting, Ogre::RTShader::FFPFog, Ogre::RTShader::IntegratedPSSM3, Ogre::RTShader::FFPTexturing, Ogre::RTShader::FFPLighting, and Ogre::RTShader::FFPTransform.

copyFrom()

virtual void Ogre::RTShader::SubRenderState::copyFrom ( const SubRenderState &  rhs )

pure virtual

Copy details from a given sub render state to this one.

Parameters

rhs	the source sub state to copy from.

Implemented in Ogre::RTShader::TriplanarTexturing, Ogre::RTShader::TextureAtlasSampler, Ogre::RTShader::LayeredBlending, Ogre::RTShader::FFPAlphaTest, Ogre::RTShader::HardwareSkinning, Ogre::RTShader::PerPixelLighting, Ogre::RTShader::FFPColour, Ogre::RTShader::FFPFog, Ogre::RTShader::IntegratedPSSM3, Ogre::RTShader::FFPTexturing, Ogre::RTShader::FFPLighting, Ogre::RTShader::NormalMapLighting, and Ogre::RTShader::FFPTransform.

operator=()

SubRenderState& Ogre::RTShader::SubRenderState::operator=

(

const SubRenderState &

rhs

)

Operator = declaration.

Assign the given source sub state to this sub state.

Parameters

rhs	the source sub state to copy from.

createCpuSubPrograms()

virtual bool Ogre::RTShader::SubRenderState::createCpuSubPrograms ( ProgramSet *  programSet )

virtual

Create sub programs that represents this sub render state as part of a program set.

The given program set contains CPU programs that represents a vertex shader and pixel shader. One should use these program class API to create a representation of the sub state he wished to implement.

Parameters

programSet

container class of CPU and GPU programs that this sub state will affect on.

Reimplemented in Ogre::RTShader::FFPTransform.

updateGpuProgramsParams()

virtual void Ogre::RTShader::SubRenderState::updateGpuProgramsParams ( Renderable *  rend, Pass *  pass, const AutoParamDataSource *  source, const LightList *  pLightList  )

inlinevirtual

Update GPU programs parameters before a rendering operation occurs.

This method is called in the context of SceneManager::renderSingle object via the RenderObjectListener interface and lets this sub render state instance opportunity to update custom GPU program parameters before the rendering action occurs.

See also

RenderObjectListener::notifyRenderSingleObject.

Parameters

rend	The renderable that is about to be rendered.
pass	The pass that used for this rendering.
source	The auto parameter source.
pLightList	The light list used in the current rendering context.

Reimplemented in Ogre::RTShader::TriplanarTexturing, Ogre::RTShader::TextureAtlasSampler, Ogre::RTShader::FFPAlphaTest, Ogre::RTShader::PerPixelLighting, Ogre::RTShader::FFPFog, Ogre::RTShader::IntegratedPSSM3, Ogre::RTShader::FFPTexturing, Ogre::RTShader::FFPLighting, and Ogre::RTShader::NormalMapLighting.

preAddToRenderState()

virtual bool Ogre::RTShader::SubRenderState::preAddToRenderState ( const RenderState *  renderState, Pass *  srcPass, Pass *  dstPass  )

inlinevirtual

Called before adding this sub render state to the given render state.

Allows this sub render state class to configure specific parameters depending on source pass or parent render state. Return of false value will cause canceling the add operation.

Parameters

renderState	The target render state container this sub render state is about to be added.
srcPass	The source pass.
dstPass	The destination pass.

Reimplemented in Ogre::RTShader::TriplanarTexturing, Ogre::RTShader::TextureAtlasSampler, Ogre::RTShader::HardwareSkinning, Ogre::RTShader::PerPixelLighting, Ogre::RTShader::FFPColour, Ogre::RTShader::FFPFog, Ogre::RTShader::IntegratedPSSM3, Ogre::RTShader::FFPAlphaTest, Ogre::RTShader::FFPTexturing, Ogre::RTShader::FFPLighting, Ogre::RTShader::NormalMapLighting, and Ogre::RTShader::FFPTransform.

getAccessor() [1/2]

SubRenderStateAccessorPtr Ogre::RTShader::SubRenderState::getAccessor

(

)

Return the accessor object to this sub render state.

See also

SubRenderStateAccessor.

getAccessor() [2/2]

SubRenderStateAccessorPtr Ogre::RTShader::SubRenderState::getAccessor

(

)

const

Return the accessor object to this sub render state.

See also

SubRenderStateAccessor.

---

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

• OgreShaderSubRenderState.h