Ogre::RTShader::LayeredBlending Class Reference

#include <OgreShaderExLayeredBlending.h>

Inheritance diagram for Ogre::RTShader::LayeredBlending:

Classes
struct	TextureBlend

Public Types
enum	BlendMode {   LB_Invalid = -1 , LB_FFPBlend , LB_BlendNormal , LB_BlendLighten ,   LB_BlendDarken , LB_BlendMultiply , LB_BlendAverage , LB_BlendAdd ,   LB_BlendSubtract , LB_BlendDifference , LB_BlendNegation , LB_BlendExclusion ,   LB_BlendScreen , LB_BlendOverlay , LB_BlendSoftLight , LB_BlendHardLight ,   LB_BlendColorDodge , LB_BlendColorBurn , LB_BlendLinearDodge , LB_BlendLinearBurn ,   LB_BlendLinearLight , LB_BlendVividLight , LB_BlendPinLight , LB_BlendHardMix ,   LB_BlendReflect , LB_BlendGlow , LB_BlendPhoenix , LB_BlendSaturation ,   LB_BlendColor , LB_BlendLuminosity , LB_MaxBlendModes }
enum	SourceModifier {   SM_Invalid = -1 , SM_None , SM_Source1Modulate , SM_Source2Modulate ,   SM_Source1InvModulate , SM_Source2InvModulate , SM_MaxSourceModifiers }

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::String &	getType () const override
bool	setBlendMode (uint16 index, const String &mode)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	setBlendMode (unsigned short index, BlendMode 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)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
void	setSourceModifier (unsigned short index, SourceModifier 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 String &	getType () 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...
SubRenderState &	operator= (const SubRenderState &rhs)
	Operator = declaration. 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

Member Enumeration Documentation

BlendMode

enum Ogre::RTShader::LayeredBlending::BlendMode

Enumerator
LB_Invalid
LB_FFPBlend
LB_BlendNormal
LB_BlendLighten
LB_BlendDarken
LB_BlendMultiply
LB_BlendAverage
LB_BlendAdd
LB_BlendSubtract
LB_BlendDifference
LB_BlendNegation
LB_BlendExclusion
LB_BlendScreen
LB_BlendOverlay
LB_BlendSoftLight
LB_BlendHardLight
LB_BlendColorDodge
LB_BlendColorBurn
LB_BlendLinearDodge
LB_BlendLinearBurn
LB_BlendLinearLight
LB_BlendVividLight
LB_BlendPinLight
LB_BlendHardMix
LB_BlendReflect
LB_BlendGlow
LB_BlendPhoenix
LB_BlendSaturation
LB_BlendColor
LB_BlendLuminosity
LB_MaxBlendModes

SourceModifier

enum Ogre::RTShader::LayeredBlending::SourceModifier

Enumerator
SM_Invalid
SM_None
SM_Source1Modulate
SM_Source2Modulate
SM_Source1InvModulate
SM_Source2InvModulate
SM_MaxSourceModifiers

Constructor & Destructor Documentation

LayeredBlending()

Ogre::RTShader::LayeredBlending::LayeredBlending

(

)

Class default constructor.

Member Function Documentation

getType()

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

overridevirtual

See also

SubRenderState::getType.

Implements Ogre::RTShader::SubRenderState.

setBlendMode() [1/2]

void Ogre::RTShader::LayeredBlending::setBlendMode	(	unsigned short	index,
		BlendMode	mode
	)

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

Parameters

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

setBlendMode() [2/2]

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

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

getBlendMode()

BlendMode Ogre::RTShader::LayeredBlending::getBlendMode

(

unsigned short

index

)

const

Return the blend mode of the given texture unit index.

setSourceModifier() [1/2]

void Ogre::RTShader::LayeredBlending::setSourceModifier	(	unsigned short	index,
		SourceModifier	modType,
		int	customNum
	)

Set the source modifier parameters for a given texture unit.

Parameters

index	Texture blend index
modType	The source modification type to use
customNum	The custom parameter number used to control the modification

setSourceModifier() [2/2]

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

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

index	Texture blend index
modType	The source modification type to use
customNum	The custom parameter number used to control the modification

copyFrom()

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

overridevirtual

See also

SubRenderState::copyFrom.

Implements Ogre::RTShader::SubRenderState.

Member Data Documentation

Type

String Ogre::RTShader::LayeredBlending::Type

static

---

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

• OgreShaderExLayeredBlending.h