crystalspace.jbind.interfaces.ivideo.effects.efdef
Interface iEffectDefinition

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csEffectDefinition

public interface iEffectDefinition

extends iBase

Effect definition.

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/pubapi/structiEffectDefinition.php

Method Summary

iEffectTechnique	createTechnique() Create a new technique.
java.lang.String	getName() Retrieve name of effect.
iEffectTechnique	getTechnique(int technique) Retrieve a technique.
int	getTechniqueCount() Get number of techniques.
float	getVariableFloat(int variableID) Get variable value as float.
int	getVariableID(int string) Get/create variable.
int	getVariableID(int string, boolean create) Get/create variable.
char	getVariableType(int variableID) Get varaibletype.
csEffectVector4	getVariableVector4(int variableID) Get variable value as csEffectVector4.
void	setName(java.lang.String name) Set this Effect's name.
void	setVariableFloat(int variableID, float value) Set variable value as float.
void	setVariableVector4(int variableID, csEffectVector4 value) Set variable value as vector4.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

createTechnique

public iEffectTechnique createTechnique()

Create a new technique.

Returns:

getName

public java.lang.String getName()

Retrieve name of effect.

Specified by:

getName in interface iBase

Returns:

See Also:

iBase.getName()

getTechnique

public iEffectTechnique getTechnique(int technique)

Retrieve a technique.

Parameters:

technique -

Returns:

getTechniqueCount

public int getTechniqueCount()

Get number of techniques.

Returns:

getVariableFloat

public float getVariableFloat(int variableID)

Get variable value as float.

Parameters:

variableID -

Returns:

getVariableID

public int getVariableID(int string)

Get/create variable.

Parameters:

string -

Returns:

getVariableID

public int getVariableID(int string,
                         boolean create)

Get/create variable.

Parameters:

string -

create -

Returns:

getVariableType

public char getVariableType(int variableID)

Get varaibletype.

Parameters:

variableID -

Returns:

getVariableVector4

public csEffectVector4 getVariableVector4(int variableID)

Get variable value as csEffectVector4.

Parameters:

variableID -

Returns:

setName

public void setName(java.lang.String name)

Set this Effect's name.

Parameters:

name -

setVariableFloat

public void setVariableFloat(int variableID,
                             float value)

Set variable value as float.

Parameters:

variableID -

value -

setVariableVector4

public void setVariableVector4(int variableID,
                               csEffectVector4 value)

Set variable value as vector4.

Parameters:

variableID -

value -