GLFX::IEffect Struct Reference

#include <glfx.h>

Inheritance diagram for GLFX::IEffect:

List of all members.

---

Detailed Description

Allows accessing local techniques, and setting effect parameters.

Public Member Functions
virtual long	GetTechniqueCount ()=0
virtual ITechnique *	GetTechnique (long num)=0
virtual ITechnique *	FindTechnique (const char *name)=0
virtual long	GetParameterId (const char *name)=0
virtual void	SetParameterFloat (long id, GLsizei components, GLsizei count, float *value)=0
virtual void	SetParameterTexture (long id, GLuint texture)=0
virtual void	ReloadTextures ()=0

---

Member Function Documentation

virtual long GLFX::IEffect::GetTechniqueCount

(

)

[pure virtual]

Return number of techniques in this effect.

Returns:

number of techniques

virtual ITechnique* GLFX::IEffect::GetTechnique

(

long

num

)

[pure virtual]

Gets a technique by number.

Parameters:

num

technique number

Returns:

interface to the technique

virtual ITechnique* GLFX::IEffect::FindTechnique

(

const char *

name

)

[pure virtual]

Finds a technique by name, as specified in .glfx file.

Returns 0 if not found.

Parameters:

name

technique name

Returns:

technique interface

virtual long GLFX::IEffect::GetParameterId

(

const char *

name

)

[pure virtual]

Finds a parameter by name and returns its identifier.

Returns -1 if no such parameter exists.

Parameters:

name

parameter name

Returns:

parameter identifier

virtual void GLFX::IEffect::SetParameterFloat	(	long	id,
		GLsizei	components,
		GLsizei	count,
		float *	value
	)			[pure virtual]

Sets float parameter value.

This method accepts a array of vectors.

Parameters:

	id	parameter identifier
	components	dimension of the input vector
	count	number of vectors. Currently it should be 1.
	value	vectors

virtual void GLFX::IEffect::SetParameterTexture	(	long	id,
		GLuint	texture
	)			[pure virtual]

Sets texture parameter.

Parameters:

	id	parameter identifier
	texture	OpenGL texture object

virtual void GLFX::IEffect::ReloadTextures

(

)

[pure virtual]

Causes all textures to be reloaded.

This method affects only textures loaded explicitly in .glfx file.

---

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

• glfx.h

---