Package com.ardor3d.renderer.effect

Class RenderEffect

java.lang.Object

com.ardor3d.renderer.effect.RenderEffect

Direct Known Subclasses:

ColorReplaceEffect, FrameBufferOutputEffect, HDREffect, SimpleBloomEffect, SpatialRTTEffect

public abstract class RenderEffect
extends Object

A RenderEffect object represents a complete set of instructions necessary for applying a specific effect to our render output. Each effect is comprised of a set of 1 or more steps (EffectStep).

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_enabled	Is this render effect active?
protected final List<EffectStep>	_steps	A list of logical steps that comprise our effect.

Constructor Summary

Constructors

Constructor	Description
RenderEffect()

Method Summary

Modifier and Type	Method	Description
boolean	isEnabled()
void	prepare(EffectManager manager)	Do any setup necessary for our effect prior.
void	render(EffectManager manager)	Render this effect.
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Field Details

_steps

protected final List<EffectStep> _steps

A list of logical steps that comprise our effect.

_enabled

protected boolean _enabled

Is this render effect active?

Constructor Details

RenderEffect

public RenderEffect()

Method Details

prepare

public void prepare(EffectManager manager)

Do any setup necessary for our effect prior. This should be called only once, or on changes to the effect chain.

Parameters:

manager - the effect manager

render

public void render(EffectManager manager)

Render this effect.

Parameters:

manager - the effect manager

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)