OGRE  13.2
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::FFPColour Class Reference

Colour sub render state implementation of the Fixed Function Pipeline. More...

#include <OgreShaderFFPColour.h>

+ Inheritance diagram for Ogre::RTShader::FFPColour:

Public Types

enum  StageFlags {
  SF_VS_INPUT_DIFFUSE = 1 << 1, SF_VS_OUTPUT_DIFFUSE = 1 << 2, SF_VS_OUTPUT_SPECULAR = 1 << 3, SF_PS_INPUT_DIFFUSE = 1 << 4,
  SF_PS_INPUT_SPECULAR = 1 << 5
}
 

Public Member Functions

 FFPColour ()
 Class default constructor. More...
 
void addResolveStageMask (unsigned int mask)
 Add the given mask to resolve stage flags that this sub render state will produce. More...
 
virtual void copyFrom (const SubRenderState &rhs)
 
virtual int getExecutionOrder () const
 
unsigned int getResolveStageFlags () const
 Get the current resolve stage flags. More...
 
virtual const StringgetType () const
 
virtual bool preAddToRenderState (const RenderState *renderState, Pass *srcPass, Pass *dstPass)
 
void removeResolveStageMask (unsigned int mask)
 Remove the given mask from the resolve stage flags that this sub render state will produce. More...
 
void setResolveStageFlags (unsigned int flags)
 Set the resolve stage flags that this sub render state will produce. More...
 
- Public Member Functions inherited from Ogre::RTShader::SubRenderState
 SubRenderState ()
 Class default constructor. More...
 
virtual ~SubRenderState ()
 Class destructor. 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...
 
SubRenderStateoperator= (const SubRenderState &rhs)
 Operator = declaration. More...
 
virtual bool setParameter (const String &name, const String &value)
 generic set method for parameters that connot be derived in preAddToRenderState More...
 
virtual void updateGpuProgramsParams (Renderable *rend, const Pass *pass, const AutoParamDataSource *source, const LightList *pLightList)
 Update GPU programs parameters before a rendering operation occurs. More...
 

Static Public Attributes

static String Type
 

Detailed Description

Colour sub render state implementation of the Fixed Function Pipeline.

Derives from SubRenderState class.

Member Enumeration Documentation

◆ StageFlags

Enumerator
SF_VS_INPUT_DIFFUSE 
SF_VS_OUTPUT_DIFFUSE 
SF_VS_OUTPUT_SPECULAR 
SF_PS_INPUT_DIFFUSE 
SF_PS_INPUT_SPECULAR 

Constructor & Destructor Documentation

◆ FFPColour()

Ogre::RTShader::FFPColour::FFPColour ( )

Class default constructor.

Member Function Documentation

◆ getType()

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

◆ getExecutionOrder()

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

◆ copyFrom()

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

◆ preAddToRenderState()

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

◆ setResolveStageFlags()

void Ogre::RTShader::FFPColour::setResolveStageFlags ( unsigned int  flags)
inline

Set the resolve stage flags that this sub render state will produce.

I.E - If one want to specify that the vertex shader program needs to get a diffuse component and the pixel shader should output diffuse component he should pass SF_VS_INPUT_DIFFUSE.

Parameters
flagsThe stage flag to set.

◆ getResolveStageFlags()

unsigned int Ogre::RTShader::FFPColour::getResolveStageFlags ( ) const
inline

Get the current resolve stage flags.

◆ addResolveStageMask()

void Ogre::RTShader::FFPColour::addResolveStageMask ( unsigned int  mask)
inline

Add the given mask to resolve stage flags that this sub render state will produce.

Parameters
maskThe mask to add to current flag set.

◆ removeResolveStageMask()

void Ogre::RTShader::FFPColour::removeResolveStageMask ( unsigned int  mask)
inline

Remove the given mask from the resolve stage flags that this sub render state will produce.

Parameters
maskThe mask to remove from current flag set.

Member Data Documentation

◆ Type

String Ogre::RTShader::FFPColour::Type
static

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