Defines the sequence of Shader objects used to render an Actor. More...

#include <Effect.hpp>

Inheritance diagram for vl::Effect:

Public Member Functions
	Effect ()
	Constructor.
ref< Effect >	shallowCopy (EShaderCopyMode shader_copy) const
Effect &	shallowCopyFrom (const Effect &other, EShaderCopyMode shader_copy)
ref< Effect >	deepCopy () const
Effect &	deepCopyFrom (const Effect &other)
void	setRenderRank (int rank)
	Modifies the rendering rank of an Actor.
int	renderRank () const
	Returns the rendering rank of an Effect.
const ref< ShaderPasses > &	lod (int lod_level) const
	Returns the ShaderPasses representing the specified LOD level.
ref< ShaderPasses > &	lod (int lod_level)
	Returns the ShaderPasses representing the specified LOD level.
Shader *	shader (int lodi=0, int pass=0)
	Utility function, same as `'lod`(lodi)->at(pass);'.
const Shader *	shader (int lodi=0, int pass=0) const
	Utility function, same as `'lod`(lodi)->at(pass);'.
void	setLOD (int lodi, Shader shader1, Shader shader2=NULL, Shader shader3=NULL, Shader shader4=NULL)
	Utility function, same as `'lod`(lodi) = new ShaderPasses(shader1,shader2,shader3,shader4);'.
void	setLODEvaluator (LODEvaluator *lod_evaluator)
	Installs the LODEvaluator used to compute the current LOD at rendering time.
LODEvaluator *	lodEvaluator ()
	Returns the installed LODEvaluator (if any) or NULL.
const LODEvaluator *	lodEvaluator () const
	Returns the installed LODEvaluator (if any) or NULL.
void	setEnableMask (unsigned int mask)
	The enable mask of an Actor's Effect defines whether the actor should be rendered or not depending on the Rendering::enableMask().
unsigned int	enableMask () const
	The enable mask of an Actor's Effect defines whether the actor should be rendered or not depending on the Rendering::enableMask().
int	evaluateLOD (Actor actor, Camera camera)
	If a LODEvaluator is installed computes the effect LOD to be used otherwise returns 0.
void	setActiveLod (int lod)
	Sets the lod to be used for rendering.
int	activeLod () const
	Returns the lod to be used for rendering.
Protected Attributes
ref< ShaderPasses >	mLODShaders [VL_MAX_EFFECT_LOD]
ref< LODEvaluator >	mLODEvaluator
int	mActiveLod
int	mRenderRank
unsigned int	mEnableMask

Detailed Description

Defines the sequence of Shader objects used to render an Actor.

Typically an Effect will have only one LOD (level of detail) with 1 pass (i.e. 1 Shader) but you can specify multiple LODs each of which defines its own set of Shader[s].

When a LOD has more than one Shader the Actor is rendered several times, once for each Shader. This technique is called multipass rendering.

The LOD to be used during the rendering is defined at rendering time if a LODEvaluator has been installed using the method setLODEvaluator(), otherwise the LOD #0 is selected.

See also:: Shader, Actor, LODEvaluator, ShaderPasses

Definition at line 91 of file Effect.hpp.

Constructor & Destructor Documentation

vl::Effect::Effect ( ) [inline]

Constructor.

Definition at line 101 of file Effect.hpp.

References VL_DEBUG_SET_OBJECT_NAME.

Member Function Documentation

ref<Effect> vl::Effect::shallowCopy ( EShaderCopyMode shader_copy ) const [inline]

Definition at line 110 of file Effect.hpp.

Effect& vl::Effect::shallowCopyFrom	(	const Effect &	other,
		EShaderCopyMode	shader_copy
	)		`[inline]`

Definition at line 117 of file Effect.hpp.

References mActiveLod, mEnableMask, mLODEvaluator, mLODShaders, mRenderRank, vl::SCM_OwnShaders, and VL_MAX_EFFECT_LOD.

ref<Effect> vl::Effect::deepCopy ( ) const [inline]

Definition at line 139 of file Effect.hpp.

Effect& vl::Effect::deepCopyFrom ( const Effect & other ) [inline]

Definition at line 146 of file Effect.hpp.

References vl::SCM_ShareShaders, and VL_MAX_EFFECT_LOD.

void vl::Effect::setRenderRank ( int rank ) [inline]

Modifies the rendering rank of an Actor.

The rendering rank affects the order in which an Actor is rendered, the greater the rank the later the Actor is rendered. The default render rank is zero.

To know more about rendering order please see Rendering Order.