javafx.scene.effect

Class Bloom

java.lang.Object

javafx.scene.effect.Effect

javafx.scene.effect.Bloom

public class Bloom
extends Effect

A high-level effect that makes brighter portions of the input image appear to glow, based on a configurable threshold.

import javafx.scene.*;
import javafx.scene.shape.*;
import javafx.scene.text.*;
import javafx.scene.paint.*;
import javafx.scene.effect.*;

Group g = new Group();

Rectangle r = new Rectangle();
r.setX(10);
r.setY(10);
r.setWidth(160);
r.setHeight(80);
r.setFill(Color.DARKBLUE);

Text t = new Text();
t.setText("Bloom!");
t.setFill(Color.YELLOW);
t.setFont(Font.font(null, FontWeight.BOLD, 36));
t.setX(25);
t.setY(65);

g.setCache(true);
g.setEffect(new Bloom());
g.getChildren().add(r);
g.getChildren().add(t);

Property Summary

Properties

Type	Property and Description
ObjectProperty<Effect>	input The input for this Effect.
DoubleProperty	threshold The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

Constructor Summary

Constructors

Constructor and Description
Bloom()

Method Summary

Methods

Modifier and Type	Method and Description
Effect	getInput() The input for this Effect.
double	getThreshold() The threshold value controls the minimum luminosity value of the pixels that will be made to glow.
ObjectProperty<Effect>	inputProperty() The input for this Effect.
void	setInput(Effect value) The input for this Effect.
void	setThreshold(double value) The threshold value controls the minimum luminosity value of the pixels that will be made to glow.
DoubleProperty	thresholdProperty() The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

Methods inherited from class java.lang.Object

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

Property Detail

input

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

See Also:

getInput(), setInput(Effect)

threshold

The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

       Min: 0.0
       Max: 1.0
   Default: 0.3
  Identity: n/a
 

See Also:

getThreshold(), setThreshold(double)

Constructor Detail

Bloom

public Bloom()

Method Detail

setInput

public final void setInput(Effect value)

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

getInput

public final Effect getInput()

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

inputProperty

public final ObjectProperty<Effect> inputProperty()

The input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.

See Also:

getInput(), setInput(Effect)

setThreshold

public final void setThreshold(double value)

The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

       Min: 0.0
       Max: 1.0
   Default: 0.3
  Identity: n/a
 

getThreshold

public final double getThreshold()

The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

       Min: 0.0
       Max: 1.0
   Default: 0.3
  Identity: n/a
 

thresholdProperty

public final DoubleProperty thresholdProperty()

The threshold value controls the minimum luminosity value of the pixels that will be made to glow.

       Min: 0.0
       Max: 1.0
   Default: 0.3
  Identity: n/a
 

See Also:

getThreshold(), setThreshold(double)