com.jme.scene.state
Class FragmentProgramState

java.lang.Object
  com.jme.scene.state.RenderState
      com.jme.scene.state.FragmentProgramState

All Implemented Interfaces:

Savable

Direct Known Subclasses:

JOGLFragmentProgramState, LWJGLFragmentProgramState

public abstract class FragmentProgramState
extends RenderState

FragmentProgramState

Version:

$Id: FragmentProgramState.java 4336 2009-05-03 20:57:01Z christoph.luder $

Nested Class Summary

Nested classes/interfaces inherited from class com.jme.scene.state.RenderState

RenderState.StateType

Field Summary

protected float[][]	parameters Parameters local to this fragment program
protected java.nio.ByteBuffer	program
protected boolean	usingParameters If any local parameters for this FP state are set

Fields inherited from class com.jme.scene.state.RenderState

QUICK_COMPARE, RS_BLEND, RS_CLIP, RS_COLORMASK_STATE, RS_CULL, RS_FOG, RS_FRAGMENT_PROGRAM, RS_GLSL_SHADER_OBJECTS, RS_LIGHT, RS_MATERIAL, RS_MAX_STATE, RS_SHADE, RS_STENCIL, RS_TEXTURE, RS_VERTEX_PROGRAM, RS_WIREFRAME, RS_ZBUFFER

Constructor Summary

FragmentProgramState()
setEnvParameter sets an environmental fragment program parameter that is accessable by all fragment programs in memory.

Method Summary

java.lang.Class<?>	getClassTag() The peristed type for the object.
abstract java.lang.String	getProgram()
RenderState.StateType	getStateType() getStateType returns the type RenderState.StateType.FragmentProgram
int	getType() Deprecated. As of 2.0, use RenderState.getStateType() instead.
abstract boolean	isSupported() isSupported determines if the ARB_fragment_program extension is supported by current graphics configuration.
abstract void	load(java.lang.String programContents)
abstract void	load(java.net.URL file) load loads the fragment program from the specified file.
void	read(JMEImporter e)
void	setParameter(float[] param, int paramID) setParameter sets a parameter for this fragment program.
void	write(JMEExporter e)

Methods inherited from class com.jme.scene.state.RenderState

apply, createStateRecord, extract, isEnabled, needsRefresh, setEnabled, setNeedsRefresh, setQuickCompares

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

usingParameters

protected boolean usingParameters

If any local parameters for this FP state are set

parameters

protected float[][] parameters

Parameters local to this fragment program

program

protected java.nio.ByteBuffer program

Constructor Detail

FragmentProgramState

public FragmentProgramState()

setEnvParameter sets an environmental fragment program parameter that is accessable by all fragment programs in memory.

Parameters:

param - four-element array of floating point numbers

paramID - identity number of the parameter, ranging from 0 to 95

Method Detail

setParameter

public void setParameter(float[] param,
                         int paramID)

setParameter sets a parameter for this fragment program.

Parameters:

paramID - identity number of the parameter, ranging from 0 to 23

param - four-element array of floating point numbers

isSupported

public abstract boolean isSupported()

isSupported determines if the ARB_fragment_program extension is supported by current graphics configuration.

Returns:

if ARB fragment programs are supported

getType

public int getType()

Deprecated. As of 2.0, use RenderState.getStateType() instead.

Description copied from class: RenderState

Defined by the subclass, this returns an int identifying the renderstate. For example, RS_CULL or RS_TEXTURE.

Specified by:

getType in class RenderState

Returns:

com.jme.scene.state.RenderState.RS_FRAGMENT_PROGRAM

See Also:

RenderState.getType()

getStateType

public RenderState.StateType getStateType()

getStateType returns the type RenderState.StateType.FragmentProgram

Specified by:

getStateType in class RenderState

Returns:

RenderState.StateType.FragmentProgram

See Also:

RenderState.getStateType()

load

public abstract void load(java.net.URL file)

load loads the fragment program from the specified file. The program must be in ASCII format. We delegate the loading to each implementation because we do not know in what format the underlying API wants the data.

Parameters:

file - text file containing the fragment program

load

public abstract void load(java.lang.String programContents)

getProgram

public abstract java.lang.String getProgram()

write

public void write(JMEExporter e)
           throws java.io.IOException

Specified by:

write in interface Savable

Overrides:

write in class RenderState

Throws:

java.io.IOException

read

public void read(JMEImporter e)
          throws java.io.IOException

Specified by:

read in interface Savable

Overrides:

read in class RenderState

Throws:

java.io.IOException

getClassTag

public java.lang.Class<?> getClassTag()

Description copied from interface: Savable

The peristed type for the object. Note that tag here does not mean XML tag, but the class that the object is tagged with.

Specified by:

getClassTag in interface Savable

Overrides:

getClassTag in class RenderState