OGRE  14.2
Object-Oriented Graphics Rendering Engine
Ogre::RTShader::LayeredBlending Class Reference

#include <OgreShaderExLayeredBlending.h>

+ Inheritance diagram for Ogre::RTShader::LayeredBlending:

Public Member Functions

 LayeredBlending ()
 Class default constructor. More...
 
void copyFrom (const SubRenderState &rhs) override
 
BlendMode getBlendMode (unsigned short index) const
 Return the blend mode of the given texture unit index. More...
 
bool getSourceModifier (unsigned short index, SourceModifier &modType, int &customNum) const
 Returns the source modifier parameters for a given texture unit. More...
 
const Ogre::StringgetType () const override
 
bool setBlendMode (uint16 index, const String &mode)
 Set the blend mode of the given texture unit layer with the previous layer. More...
 
bool setSourceModifier (unsigned short index, const String &modType, int customNum)
 Set the source modifier parameters for a given texture unit. More...
 
- Public Member Functions inherited from Ogre::RTShader::FFPTexturing
 FFPTexturing ()
 Class default constructor. More...
 
void copyFrom (const SubRenderState &rhs) override
 
int getExecutionOrder () const override
 
const StringgetType () const override
 
bool preAddToRenderState (const RenderState *renderState, Pass *srcPass, Pass *dstPass) override
 
- 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 void setParameter (const String &name, const Any &value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
bool setParameter (const String &name, const char *value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 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
 
- Static Public Attributes inherited from Ogre::RTShader::FFPTexturing
static String Type
 

Constructor & Destructor Documentation

◆ LayeredBlending()

Ogre::RTShader::LayeredBlending::LayeredBlending ( )

Class default constructor.

Member Function Documentation

◆ getType()

const Ogre::String& Ogre::RTShader::LayeredBlending::getType ( ) const
overridevirtual

◆ setBlendMode()

bool Ogre::RTShader::LayeredBlending::setBlendMode ( uint16  index,
const String mode 
)

Set the blend mode of the given texture unit layer with the previous layer.

Parameters
indexThe texture unit texture. Textures units (index-1) and (index) will be blended.
modeThe blend mode to apply.

◆ getBlendMode()

BlendMode Ogre::RTShader::LayeredBlending::getBlendMode ( unsigned short  index) const

Return the blend mode of the given texture unit index.

◆ setSourceModifier()

bool Ogre::RTShader::LayeredBlending::setSourceModifier ( unsigned short  index,
const String modType,
int  customNum 
)

Set the source modifier parameters for a given texture unit.

Parameters
indexTexture blend index
modTypeThe source modification type to use
customNumThe custom parameter number used to control the modification

◆ getSourceModifier()

bool Ogre::RTShader::LayeredBlending::getSourceModifier ( unsigned short  index,
SourceModifier &  modType,
int &  customNum 
) const

Returns the source modifier parameters for a given texture unit.

Returns
True if a valid modifier exist for the given texture unit
Parameters
indexTexture blend index
modTypeThe source modification type to use
customNumThe custom parameter number used to control the modification

◆ copyFrom()

void Ogre::RTShader::LayeredBlending::copyFrom ( const SubRenderState rhs)
overridevirtual

Member Data Documentation

◆ Type

String Ogre::RTShader::LayeredBlending::Type
static

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