OGRE  1.12.13
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::FFPFog Class Reference

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

#include <OgreShaderFFPFog.h>

+ Inheritance diagram for Ogre::RTShader::FFPFog:

Public Types

enum  CalcMode { CM_PER_VERTEX = 1, CM_PER_PIXEL = 2 }
 

Public Member Functions

 FFPFog ()
 Class default constructor. More...
 
virtual void copyFrom (const SubRenderState &rhs)
 
CalcMode getCalcMode () const
 Return the current calculation mode. More...
 
virtual int getExecutionOrder () const
 
virtual const StringgetType () const
 
virtual bool preAddToRenderState (const RenderState *renderState, Pass *srcPass, Pass *dstPass)
 
void setCalcMode (CalcMode calcMode)
 Set the fog calculation mode. More...
 
void setFogProperties (FogMode fogMode, const ColourValue &fogColour, float fogStart, float fogEnd, float fogDensity)
 Set the fog properties this fog sub render state should emulate. More...
 
bool setParameter (const String &name, const String &value) override
 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)
 
- 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...
 

Static Public Attributes

static String Type
 

Detailed Description

Fog sub render state implementation of the Fixed Function Pipeline.

See also
http://msdn.microsoft.com/en-us/library/bb173398.aspx Derives from SubRenderState class.

Member Enumeration Documentation

◆ CalcMode

Enumerator
CM_PER_VERTEX 
CM_PER_PIXEL 

Constructor & Destructor Documentation

◆ FFPFog()

Ogre::RTShader::FFPFog::FFPFog ( )

Class default constructor.

Member Function Documentation

◆ getType()

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

◆ getExecutionOrder()

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

◆ updateGpuProgramsParams()

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

◆ copyFrom()

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

◆ preAddToRenderState()

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

◆ setFogProperties()

void Ogre::RTShader::FFPFog::setFogProperties ( FogMode  fogMode,
const ColourValue fogColour,
float  fogStart,
float  fogEnd,
float  fogDensity 
)

Set the fog properties this fog sub render state should emulate.

Parameters
fogModeThe fog mode to emulate (FOG_NONE, FOG_EXP, FOG_EXP2, FOG_LINEAR).
fogColourThe colour of the fog.
fogStartStart distance of fog, used for linear mode only.
fogEndEnd distance of fog, used for linear mode only.
fogDensityFog density used in exponential modes only.
See also
http://msdn.microsoft.com/en-us/library/bb173401.aspx

◆ setCalcMode()

void Ogre::RTShader::FFPFog::setCalcMode ( CalcMode  calcMode)
inline

Set the fog calculation mode.

Either per vertex or per pixel.

Parameters
calcModeThe calculation mode to set.

◆ setParameter()

bool Ogre::RTShader::FFPFog::setParameter ( const String name,
const String value 
)
overridevirtual

generic set method for parameters that connot be derived in preAddToRenderState

Reimplemented from Ogre::RTShader::SubRenderState.

◆ getCalcMode()

CalcMode Ogre::RTShader::FFPFog::getCalcMode ( ) const
inline

Return the current calculation mode.

Member Data Documentation

◆ Type

String Ogre::RTShader::FFPFog::Type
static

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