Public API Reference

                 

---

iEffectDefinition Struct Reference
[3D]

Effect definition. More...

#include <efdef.h>

Inheritance diagram for iEffectDefinition:

List of all members.

Public Methods
virtual csPtr< iEffectTechnique >	CreateTechnique ()=0
	Create a new technique. More...
virtual int	GetTechniqueCount ()=0
	Get number of techniques. More...
virtual iEffectTechnique *	GetTechnique (int technique)=0
	Retrieve a technique. More...
virtual void	SetName (const char *name)=0
	Set this Effect's name. More...
virtual const char *	GetName ()=0
	Retrieve name of effect. More...
virtual float	GetVariableFloat (int variableID)=0
	Get variable value as float. More...
virtual csEffectVector4	GetVariableVector4 (int variableID)=0
	Get variable value as csEffectVector4. More...
virtual char	GetVariableType (int variableID)=0
	Get varaibletype. More...
virtual void	SetVariableFloat (int variableID, float value)=0
	Set variable value as float. More...
virtual void	SetVariableVector4 (int variableID, csEffectVector4 value)=0
	Set variable value as vector4. More...
virtual int	GetVariableID (uint32 string, bool create=true)=0
	Get/create variable. More...

---

Detailed Description

Effect definition.

Definition at line 42 of file efdef.h.

---

Member Function Documentation

virtual csPtr<iEffectTechnique> iEffectDefinition::CreateTechnique (    )  [pure virtual]

Create a new technique.

virtual const char* iEffectDefinition::GetName (    )  [pure virtual]

Retrieve name of effect.

virtual iEffectTechnique* iEffectDefinition::GetTechnique (  int    technique )  [pure virtual]

Retrieve a technique.

virtual int iEffectDefinition::GetTechniqueCount (    )  [pure virtual]

Get number of techniques.

virtual float iEffectDefinition::GetVariableFloat (  int    variableID )  [pure virtual]

Get variable value as float.

virtual int iEffectDefinition::GetVariableID (  uint32    string, bool    create = true )  [pure virtual]

Get/create variable.

virtual char iEffectDefinition::GetVariableType (  int    variableID )  [pure virtual]

Get varaibletype.

virtual csEffectVector4 iEffectDefinition::GetVariableVector4 (  int    variableID )  [pure virtual]

Get variable value as csEffectVector4.

virtual void iEffectDefinition::SetName (  const char *    name )  [pure virtual]

Set this Effect's name.

virtual void iEffectDefinition::SetVariableFloat (  int    variableID, float    value )  [pure virtual]

Set variable value as float.

virtual void iEffectDefinition::SetVariableVector4 (  int    variableID, csEffectVector4    value )  [pure virtual]

Set variable value as vector4.

---

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

• efdef.h

---