com.jme3.post

Class Filter.Pass

java.lang.Object

com.jme3.post.Filter.Pass

Enclosing class:

Filter

public class Filter.Pass
extends java.lang.Object

Passes are like filters within filters. Some filters will need multiple passes before the final render.

Field Summary

Fields

Modifier and Type	Field and Description
protected Texture2D	depthTexture
protected java.lang.String	name
protected Material	passMaterial
protected Texture2D	renderedTexture
protected FrameBuffer	renderFrameBuffer

Constructor Summary

Constructors

Constructor and Description
Pass()
Pass(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	beforeRender()
void	cleanup(Renderer r)
Texture2D	getDepthTexture()
Material	getPassMaterial()
Texture2D	getRenderedTexture()
FrameBuffer	getRenderFrameBuffer()
void	init(Renderer renderer, int width, int height, Image.Format textureFormat, Image.Format depthBufferFormat) init the pass called internally
void	init(Renderer renderer, int width, int height, Image.Format textureFormat, Image.Format depthBufferFormat, int numSamples)
void	init(Renderer renderer, int width, int height, Image.Format textureFormat, Image.Format depthBufferFormat, int numSamples, boolean renderDepth) init the pass called internally
void	init(Renderer renderer, int width, int height, Image.Format textureFormat, Image.Format depthBufferFormat, int numSample, Material material) init the pass called internally
boolean	requiresDepthAsTexture()
boolean	requiresSceneAsTexture()
void	setPassMaterial(Material passMaterial)
void	setRenderedTexture(Texture2D renderedTexture)
void	setRenderFrameBuffer(FrameBuffer renderFrameBuffer)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

renderFrameBuffer

protected FrameBuffer renderFrameBuffer

renderedTexture

protected Texture2D renderedTexture

depthTexture

protected Texture2D depthTexture

passMaterial

protected Material passMaterial

name

protected java.lang.String name

Constructor Detail

Pass

public Pass(java.lang.String name)

Pass

public Pass()

Method Detail

init

public void init(Renderer renderer,
                 int width,
                 int height,
                 Image.Format textureFormat,
                 Image.Format depthBufferFormat,
                 int numSamples,
                 boolean renderDepth)

init the pass called internally

Parameters:

renderer - (not null)

width - the width (in pixels, ≥0)

height - the height (in pixels, ≥0)

textureFormat - format of the rendered texture

depthBufferFormat - format of the depth buffer

numSamples - the number of samples per pixel (for multisampling)

renderDepth - true to create a depth texture, false for none

init

public void init(Renderer renderer,
                 int width,
                 int height,
                 Image.Format textureFormat,
                 Image.Format depthBufferFormat)

init the pass called internally

Parameters:

renderer - (not null)

width - the image width (in pixels, ≥0)

height - the image height (in pixels, ≥0)

textureFormat - the format of the rendered texture

depthBufferFormat - the format of the depth buffer

init

public void init(Renderer renderer,
                 int width,
                 int height,
                 Image.Format textureFormat,
                 Image.Format depthBufferFormat,
                 int numSamples)

init

public void init(Renderer renderer,
                 int width,
                 int height,
                 Image.Format textureFormat,
                 Image.Format depthBufferFormat,
                 int numSample,
                 Material material)

init the pass called internally

Parameters:

renderer - (not null)

width - the image width (in pixels, ≥0)

height - the image height (in pixels, ≥0)

textureFormat - the format of the rendered texture

depthBufferFormat - the format of the depth buffer

numSample - the number of samples per pixel (for multisampling)

material - the Material for this pass

requiresSceneAsTexture

public boolean requiresSceneAsTexture()

requiresDepthAsTexture

public boolean requiresDepthAsTexture()

beforeRender

public void beforeRender()

getRenderFrameBuffer

public FrameBuffer getRenderFrameBuffer()

setRenderFrameBuffer

public void setRenderFrameBuffer(FrameBuffer renderFrameBuffer)

getDepthTexture

public Texture2D getDepthTexture()

getRenderedTexture

public Texture2D getRenderedTexture()

setRenderedTexture

public void setRenderedTexture(Texture2D renderedTexture)

getPassMaterial

public Material getPassMaterial()

setPassMaterial

public void setPassMaterial(Material passMaterial)

cleanup

public void cleanup(Renderer r)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object