com.jme3.post.filters

Class ToneMapFilter

java.lang.Object

com.jme3.post.Filter

com.jme3.post.filters.ToneMapFilter

All Implemented Interfaces:

Savable

public class ToneMapFilter
extends Filter

Tone-mapping filter that uses filmic curve.

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.post.Filter

Filter.Pass

Field Summary

Fields inherited from class com.jme3.post.Filter

defaultPass, enabled, material, postRenderPasses, processor

Constructor Summary

Constructors

Constructor and Description
ToneMapFilter() Creates a tone-mapping filter with the default white-point of 11.2.
ToneMapFilter(Vector3f whitePoint) Creates a tone-mapping filter with the specified white-point.

Method Summary

Modifier and Type	Method and Description
protected Material	getMaterial() Must return the material used for this filter.
Vector3f	getWhitePoint() Get the scene white point.
protected void	initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h) Initialization of filter subclasses.
protected boolean	isRequiresDepthTexture() Override this method and return true if your Filter needs the depth texture
void	read(JmeImporter im) Override this method if you want to load extra properties when the filter is loaded else only basic properties of the filter will be loaded This method should always begin by super.read(im);
void	setWhitePoint(Vector3f whitePoint) Set the scene white point.
void	write(JmeExporter ex) Override this method if you want to save extra properties when the filter is saved else only basic properties of the filter will be saved This method should always begin by super.write(ex);

Methods inherited from class com.jme3.post.Filter

cleanup, cleanUpFilter, getDefaultPassDepthFormat, getDefaultPassTextureFormat, getName, getPostRenderPasses, getRenderedTexture, getRenderFrameBuffer, init, isEnabled, isRequiresBilinear, isRequiresSceneTexture, postFilter, postFrame, postQueue, preFrame, setDepthTexture, setEnabled, setName, setProcessor, setRenderedTexture, setRenderFrameBuffer

Methods inherited from class java.lang.Object

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

Constructor Detail

ToneMapFilter

public ToneMapFilter()

Creates a tone-mapping filter with the default white-point of 11.2.

ToneMapFilter

public ToneMapFilter(Vector3f whitePoint)

Creates a tone-mapping filter with the specified white-point.

Parameters:

whitePoint - The intensity of the brightest part of the scene.

Method Detail

isRequiresDepthTexture

protected boolean isRequiresDepthTexture()

Description copied from class: Filter

Override this method and return true if your Filter needs the depth texture

Overrides:

isRequiresDepthTexture in class Filter

Returns:

true if your Filter need the depth texture

initFilter

protected void initFilter(AssetManager manager,
                          RenderManager renderManager,
                          ViewPort vp,
                          int w,
                          int h)

Description copied from class: Filter

Initialization of filter subclasses. This method is called once when the filter is added to the FilterPostProcessor It should contain Material initializations and extra passes initialization

Specified by:

initFilter in class Filter

Parameters:

manager - the assetManager

renderManager - the renderManager

vp - the viewPort where this filter is rendered

w - the width of the filter

h - the height of the filter

getMaterial

protected Material getMaterial()

Description copied from class: Filter

Must return the material used for this filter. this method is called every frame.

Specified by:

getMaterial in class Filter

Returns:

the material used for this filter.

setWhitePoint

public void setWhitePoint(Vector3f whitePoint)

Set the scene white point.

Parameters:

whitePoint - The intensity of the brightest part of the scene.

getWhitePoint

public Vector3f getWhitePoint()

Get the scene white point.

Returns:

The intensity of the brightest part of the scene.

write

public void write(JmeExporter ex)
           throws java.io.IOException

Description copied from class: Filter

Override this method if you want to save extra properties when the filter is saved else only basic properties of the filter will be saved This method should always begin by super.write(ex);

Specified by:

write in interface Savable

Overrides:

write in class Filter

Parameters:

ex - the exporter (not null)

Throws:

java.io.IOException - from the exporter

read

public void read(JmeImporter im)
          throws java.io.IOException

Description copied from class: Filter

Override this method if you want to load extra properties when the filter is loaded else only basic properties of the filter will be loaded This method should always begin by super.read(im);

Specified by:

read in interface Savable

Overrides:

read in class Filter

Throws:

java.io.IOException