GlsRenderEffect Class Reference

Inheritance diagram for GlsRenderEffect:

Public Member Functions
	GlsRenderEffect (GlsRenderEffect &src)
	GlsRenderEffect (disti::GlsRenderEffect *renderEffect, bool incEditorRef)
None	AddRef ()
None	Release ()
int	GlsRenderEffect_ClassID ()
None	SetupEffect (MaterialArray &materialPalette, TexturePalette *texturePalette, TextureSettings &textureSettings, float *viewToWorld3x3, int maxLightNum, int activeLightMask)
None	CleanupEffect ()
int	Compare (GlsRenderEffect *other)
bool	Equals (GlsRenderEffect *other)
GlsRenderEffect *	Clone ()=0
int	GetVertexAttribIndexForSemantic (int semanticEnum)
int	GetVertexAttribIndexForSemantic (int semanticEnum)=0

Static Public Member Functions
static int	SetDebugMode (str modeName, bool value)
static int	RegisterNewClassID (str debugStr=str())

Additional Inherited Members
Public Types inherited from VertexAttribIndexLookup
enum	AttributeSemanticEnum {   ATTRIB_UNDEFINED = 0 ,   ATTRIB_POSITION = 0x80000000 ,   ATTRIB_NORMAL ,   ATTRIB_BLENDWEIGHT ,   ATTRIB_TANGENT ,   ATTRIB_BINORMAL ,   ATTRIB_BLENDINDICES ,   ATTRIB_PSIZE ,   ATTRIB_TEXCOORD0 ,   ATTRIB_TEXCOORD1 ,   ATTRIB_TEXCOORD2 ,   ATTRIB_TEXCOORD3 ,   ATTRIB_TEXCOORD4 ,   ATTRIB_TEXCOORD5 ,   ATTRIB_TEXCOORD6 ,   ATTRIB_TEXCOORD7 }

Detailed Description

Render effect class.

Encapsulates an effect that can be applied to the OpenGL state to modify the appearance of geometry. This API currently only supports single pass techniques.

Constructor & Destructor Documentation

GlsRenderEffect() [1/2]

GlsRenderEffect::GlsRenderEffect

(

GlsRenderEffect &

src

)

GlsRenderEffect() [2/2]

GlsRenderEffect::GlsRenderEffect	(	disti::GlsRenderEffect *	renderEffect,
		bool	incEditorRef
	)

ctor

Parameters

renderEffect	GlsRenderEffect to wrap
incEditorRef	true if to increment editor ref on with wrapped group (i.e. if this pointer came from the editor) else false

Member Function Documentation

AddRef()

None GlsRenderEffect::AddRef

(

)

Manage references to the effect.

CleanupEffect()

None GlsRenderEffect::CleanupEffect

(

)

Remove the effect trom the OpenGL state.

Clone()

GlsRenderEffect * GlsRenderEffect::Clone ( )

pure virtual

Returns a new instance of the effect with the same settings as this one.

Implemented in Effect_DiffNormSpecRefl.

Compare()

int GlsRenderEffect::Compare

(

GlsRenderEffect *

other

)

Returns 0 if the effects are equal, a positive number if this effect should sort after the other effect, and a negative number if this effect should sort before the other effect.

The rendering system uses this to sort effects.

Equals()

bool GlsRenderEffect::Equals

(

GlsRenderEffect *

other

)

Determine if two GlsRenderEffect instances are equivalent The rendering system uses this to eliminate redundant effects.

GetVertexAttribIndexForSemantic()

int GlsRenderEffect::GetVertexAttribIndexForSemantic ( int  semanticEnum )

virtual

VertexAttribIndexLookup override /////////////////////////////////////////.

Returns

The attributeIndex that should be used to pass the vertex attributes or -1 if they are not needed (see glVertexAttrib)

Parameters

semanticEnum

The sematic value (see AttributeSemanticEnum)

Implements VertexAttribIndexLookup.

GlsRenderEffect_ClassID()

int GlsRenderEffect::GlsRenderEffect_ClassID

(

)

RegisterNewClassID()

static int GlsRenderEffect::RegisterNewClassID ( str  debugStr = str() )

static

Release()

None GlsRenderEffect::Release

(

)

SetDebugMode()

static int GlsRenderEffect::SetDebugMode ( str  modeName, bool  value  )

static

SetupEffect()

None GlsRenderEffect::SetupEffect	(	MaterialArray &	materialPalette,
		TexturePalette *	texturePalette,
		TextureSettings &	textureSettings,
		float *	viewToWorld3x3,
		int	maxLightNum,
		int	activeLightMask
	)

Apply the effect to the OpenGL state.

Parameters

materialPalette	Used to access material settings
texturePalette	Used to access texture maps
textureSettings	The object-level texture settings
viewToWorld3x3	A 3x3 matrix containing the current viewToWorld transfrom. Used for environment mapping effects.
maxLightNum	Maximum number of active lights
activeLightMask	Bit mask for active lights in scene

---

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

• GlsRenderEffect.i