com.jme3.post.filters

Class ComposeFilter

java.lang.Object

com.jme3.post.Filter

com.jme3.post.filters.ComposeFilter

All Implemented Interfaces:

com.jme3.export.Savable

public class ComposeFilter
extends com.jme3.post.Filter

This filter compose a texture with the viewport texture. This is used to compose post processed texture from another viewport. the compositing is done using the alpha value of the viewportTexture : mix(compositeTextureColor, viewPortColor, viewportColor.alpha); It's important for a good result that the viewport clear color alpha be 0.

Author:

Rémy Bouquet aka Nehon

Nested Class Summary

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

com.jme3.post.Filter.Pass

Field Summary

Fields inherited from class com.jme3.post.Filter

defaultPass, enabled, material, postRenderPasses, processor

Constructor Summary

Constructors

Constructor and Description
ComposeFilter() creates a ComposeFilter
ComposeFilter(com.jme3.texture.Texture2D compositeTexture) creates a ComposeFilter with the given texture

Method Summary

Modifier and Type	Method and Description
com.jme3.texture.Texture2D	getCompositeTexture()
protected com.jme3.material.Material	getMaterial()
protected void	initFilter(com.jme3.asset.AssetManager manager, com.jme3.renderer.RenderManager renderManager, com.jme3.renderer.ViewPort vp, int w, int h)
void	read(com.jme3.export.JmeImporter im)
void	setCompositeTexture(com.jme3.texture.Texture2D compositeTexture) sets the compositeTexture
void	write(com.jme3.export.JmeExporter ex)

Methods inherited from class com.jme3.post.Filter

cleanup, cleanUpFilter, getDefaultPassDepthFormat, getDefaultPassTextureFormat, getName, getPostRenderPasses, getRenderedTexture, getRenderFrameBuffer, init, isEnabled, isRequiresBilinear, isRequiresDepthTexture, 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

ComposeFilter

public ComposeFilter()

creates a ComposeFilter

ComposeFilter

public ComposeFilter(com.jme3.texture.Texture2D compositeTexture)

creates a ComposeFilter with the given texture

Parameters:

compositeTexture - the texture to use (alias created)

Method Detail

getMaterial

protected com.jme3.material.Material getMaterial()

Specified by:

getMaterial in class com.jme3.post.Filter

getCompositeTexture

public com.jme3.texture.Texture2D getCompositeTexture()

Returns:

the compositeTexture

setCompositeTexture

public void setCompositeTexture(com.jme3.texture.Texture2D compositeTexture)

sets the compositeTexture

Parameters:

compositeTexture - the desired texture (alias created)

initFilter

protected void initFilter(com.jme3.asset.AssetManager manager,
                          com.jme3.renderer.RenderManager renderManager,
                          com.jme3.renderer.ViewPort vp,
                          int w,
                          int h)

Specified by:

initFilter in class com.jme3.post.Filter

write

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

Specified by:

write in interface com.jme3.export.Savable

Overrides:

write in class com.jme3.post.Filter

Throws:

java.io.IOException

read

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

Specified by:

read in interface com.jme3.export.Savable

Overrides:

read in class com.jme3.post.Filter

Throws:

java.io.IOException