|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jme3.post.Filter
com.jme3.post.filters.BloomFilter
public class BloomFilter
BloomFilter is used to make objects in the scene have a glow effect.
There are 2 mode : Scene and Objects.
Scene mode extracts the bright parts of the scene to make them glow
Object mode make objects glow according to their material's glowMap or their GlowColor
Nested Class Summary | |
---|---|
static class |
BloomFilter.GlowMode
GlowMode specifies if the glow will be applied to the whole scene,or to objects that have aglow color or a glow map |
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 | |
---|---|
BloomFilter()
Creates a Bloom filter |
|
BloomFilter(BloomFilter.GlowMode glowMode)
Creates the bloom filter with the specific glow mode |
Method Summary | |
---|---|
float |
getBloomIntensity()
returns the bloom intensity |
float |
getBlurScale()
returns the blur scale |
float |
getDownSamplingFactor()
returns the downSampling factor form more details see setDownSamplingFactor(float downSamplingFactor) |
float |
getExposureCutOff()
returns the exposure cutoff for more details see setExposureCutOff(float exposureCutOff) |
float |
getExposurePower()
returns the exposure power form more details see setExposurePower(float exposurePower) |
protected Material |
getMaterial()
Must return the material used for this filter. |
protected void |
initFilter(AssetManager manager,
RenderManager renderManager,
ViewPort vp,
int w,
int h)
Initialization of sub classes filters This method is called once when the filter is added to the FilterPostProcessor It should contain Material initializations and extra passes initialization |
protected void |
postQueue(RenderManager renderManager,
ViewPort viewPort)
Override this method if you want to make a pre pass, before the actual rendering of the frame |
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 |
setBloomIntensity(float bloomIntensity)
intensity of the bloom effect default is 2.0 |
void |
setBlurScale(float blurScale)
sets The spread of the bloom default is 1.5f |
void |
setDownSamplingFactor(float downSamplingFactor)
Sets the downSampling factor : the size of the computed texture will be divided by this factor. |
void |
setExposureCutOff(float exposureCutOff)
Define the color threshold on which the bloom will be applied (0.0 to 1.0) |
void |
setExposurePower(float exposurePower)
defines how many time the bloom extracted color will be multiplied by itself. |
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, isRequiresDepthTexture, isRequiresSceneTexture, postFrame, 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 |
---|
public BloomFilter()
public BloomFilter(BloomFilter.GlowMode glowMode)
glowMode
- Method Detail |
---|
protected void initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h)
Filter
initFilter
in class Filter
manager
- the assetManagerrenderManager
- the renderManagervp
- the viewPort where this filter is renderedw
- the width of the filterh
- the height of the filterprotected Material getMaterial()
Filter
getMaterial
in class Filter
protected void postQueue(RenderManager renderManager, ViewPort viewPort)
Filter
postQueue
in class Filter
public float getBloomIntensity()
public void setBloomIntensity(float bloomIntensity)
bloomIntensity
- public float getBlurScale()
public void setBlurScale(float blurScale)
blurScale
- public float getExposureCutOff()
setExposureCutOff(float exposureCutOff)
public void setExposureCutOff(float exposureCutOff)
exposureCutOff
- public float getExposurePower()
setExposurePower(float exposurePower)
public void setExposurePower(float exposurePower)
exposurePower
- public float getDownSamplingFactor()
setDownSamplingFactor(float downSamplingFactor)
public void setDownSamplingFactor(float downSamplingFactor)
downSamplingFactor
- public void write(JmeExporter ex) throws java.io.IOException
Filter
write
in interface Savable
write
in class Filter
java.io.IOException
public void read(JmeImporter im) throws java.io.IOException
Filter
read
in interface Savable
read
in class Filter
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |