OGRE  13.0
Object-Oriented Graphics Rendering Engine
Ogre::TerrainTransform Class Reference

#include <OgreTerrainShaderTransform.h>

+ Inheritance diagram for Ogre::TerrainTransform:

Public Member Functions

void copyFrom (const SubRenderState &rhs)
 
bool createCpuSubPrograms (RTShader::ProgramSet *programSet)
 Create sub programs that represents this sub render state as part of a program set. More...
 
int getExecutionOrder () const
 Get the execution order of this sub render state. More...
 
const StringgetType () const
 Get the type of this sub render state. More...
 
bool preAddToRenderState (const RTShader::RenderState *renderState, Pass *srcPass, Pass *dstPass)
 Called before adding this sub render state to the given render state. More...
 
void updateGpuProgramsParams (Renderable *rend, const Pass *pass, const AutoParamDataSource *source, const LightList *pLightList)
 Update GPU programs parameters before a rendering operation occurs. More...
 
- Public Member Functions inherited from Ogre::RTShader::SubRenderState
 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...
 
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...
 

Static Public Attributes

static String Type
 

Member Function Documentation

◆ getType()

const String& Ogre::TerrainTransform::getType ( ) const
inlinevirtual

Get the type of this sub render state.

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

Implements Ogre::RTShader::SubRenderState.

References Type.

◆ getExecutionOrder()

int Ogre::TerrainTransform::getExecutionOrder ( ) const
inlinevirtual

Get the execution order of this sub render state.

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

Implements Ogre::RTShader::SubRenderState.

References Ogre::RTShader::FFP_TRANSFORM.

◆ copyFrom()

void Ogre::TerrainTransform::copyFrom ( const SubRenderState rhs)
inline

◆ createCpuSubPrograms()

bool Ogre::TerrainTransform::createCpuSubPrograms ( RTShader::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
programSetcontainer class of CPU and GPU programs that this sub state will affect on.

Reimplemented from Ogre::RTShader::SubRenderState.

◆ preAddToRenderState()

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

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
renderStateThe target render state container this sub render state is about to be added.
srcPassThe source pass.
dstPassThe destination pass.

Reimplemented from Ogre::RTShader::SubRenderState.

◆ updateGpuProgramsParams()

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

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
rendThe renderable that is about to be rendered.
passThe pass that used for this rendering.
sourceThe auto parameter source.
pLightListThe light list used in the current rendering context.

Reimplemented from Ogre::RTShader::SubRenderState.

Member Data Documentation

◆ Type

String Ogre::TerrainTransform::Type
static

Referenced by getType().


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