GLFX::IEffect Struct Reference

#include <glfx.h>

Inheritance diagram for GLFX::IEffect:

GLFX::IObject List of all members.

Detailed Description

Allows accessing local techniques, and setting effect parameters.

Public Member Functions

virtual long GetTechniqueCount ()=0
virtual ITechniqueGetTechnique (long num)=0
virtual ITechniqueFindTechnique (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.

number of techniques

virtual ITechnique* GLFX::IEffect::GetTechnique ( long  num  )  [pure virtual]

Gets a technique by number.

num technique number
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.

name technique name
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.

name parameter name
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.

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.

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: Logo