OGRE-Next  2.3
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)
 
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...
 
CalcMode getCalcMode () const
 Return the current calculation mode. More...
 
virtual int getExecutionOrder () const
 
virtual const StringgetType () const
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete (void *ptr, void *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
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...
 
virtual void updateGpuProgramsParams (Renderable *rend, Pass *pass, const AutoParamDataSource *source, const LightList *pLightList)
 

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

◆ copyFrom()

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

◆ createCpuSubPrograms()

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

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
programSetcontainer class of CPU and GPU programs that this sub state will affect on.

Reimplemented in Ogre::RTShader::FFPTransform.

◆ getAccessor() [1/2]

SubRenderStateAccessorPtr Ogre::RTShader::SubRenderState::getAccessor ( )
inherited

Return the accessor object to this sub render state.

See also
SubRenderStateAccessor.

◆ getAccessor() [2/2]

SubRenderStateAccessorPtr Ogre::RTShader::SubRenderState::getAccessor ( ) const
inherited

Return the accessor object to this sub render state.

See also
SubRenderStateAccessor.

◆ getCalcMode()

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

Return the current calculation mode.

◆ getExecutionOrder()

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

◆ getType()

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

◆ operator delete() [1/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

◆ operator delete() [2/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator delete() [3/3]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

◆ operator delete[]() [1/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

◆ operator delete[]() [2/2]

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

◆ operator new() [1/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

◆ operator new() [2/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

◆ operator new() [3/3]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

◆ operator new[]() [1/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

◆ operator new[]() [2/2]

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

◆ preAddToRenderState()

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

◆ 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.

◆ 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

◆ updateGpuProgramsParams()

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

Member Data Documentation

◆ Type

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

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