class: BoxBlur

[13:7] extends: FxObj

Wraps JavaFX BoxBlur, an effect that blurs a node using a box filter, producing a fast but approximate Gaussian blur. The width and height properties set the size of the blur kernel in pixels, and iterations controls how many times the box filter is applied; more iterations produce a smoother result that more closely resembles a true Gaussian blur. Apply it to any node via the node's setEffect() method.

Methods

BoxBlur ()

Creates a new BoxBlur effect with default settings.
setWidth (double W)

Sets the horizontal size of the blur kernel.
- @p W is a double with the kernel width in pixels.
- @r this object
setHeight (double H)

Sets the vertical size of the blur kernel.
- @p H is a double with the kernel height in pixels.
- @r this object
setIterations (int I)

Sets the number of times the box filter is applied to produce a smoother blur.
- @p I is an int with the iteration count; higher values produce results closer to a Gaussian blur.
- @r this object
getWidth ()

Returns the horizontal size of the blur kernel.
- @r A double with the kernel width in pixels.
getHeight ()

Returns the vertical size of the blur kernel.
- @r A double with the kernel height in pixels.
getIterations ()

Returns the number of times the box filter is applied.
- @r An int with the iteration count.
widthProperty ()

Returns the DoubleProperty backing the kernel width.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
heightProperty ()

Returns the DoubleProperty backing the kernel height.
- @r An AJO wrapping javafx.beans.property.DoubleProperty.
iterationsProperty ()

Returns the IntegerProperty backing the iteration count.
- @r An AJO wrapping javafx.beans.property.IntegerProperty.
setInput (object Input)

Sets the input effect that this BoxBlur 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 BoxBlur.
- @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.