Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: Bloom

[12:7] extends: FxObj

Wraps JavaFX Bloom, an effect that makes bright areas of a node glow by adding a soft-light bloom around high-luminance pixels. The threshold property (0.0 to 1.0) controls the minimum brightness level at which pixels begin to bloom; lower values cause more of the image to glow. Apply it to any node via the node's setEffect() method.

Methods

  • Bloom ()

    Creates a new Bloom effect with default settings.

  • setThreshold (double T)

    Sets the luminance threshold above which pixels begin to bloom.

    • @p T is a double in the range 0.0 (all pixels bloom) to 1.0 (only the brightest pixels bloom).
    • @r this object
  • getThreshold ()

    Returns the luminance threshold above which pixels bloom.

    • @r A double in the range 0.0 to 1.0.
  • thresholdProperty ()

    Returns the DoubleProperty backing the threshold value.

    • @r An AJO wrapping javafx.beans.property.DoubleProperty.
  • setInput (object Input)

    Sets the input effect that this Bloom is chained to. When null the effect operates on the node directly.

    • @p Input is an Effect wrapper (e.g. another Bloom, BoxBlur, etc.) or null.
    • @r this object
  • getInput ()

    Returns the input effect chained to this Bloom.

    • @r An AJO wrapping javafx.scene.effect.Effect, or null if none is set.
  • inputProperty ()

    Returns the ObjectProperty backing the input effect reference.

    • @r An AJO wrapping javafx.beans.property.ObjectProperty.