javafx.scene.effect (JavaFX 17)

Module javafx.graphics

# Package javafx.scene.effect

Provides the set of classes for attaching graphical filter effects to JavaFX Scene Graph Nodes.

An effect is a graphical algorithm that produces an image, typically as a modification of a source image. An effect can be associated with a scene graph `Node` by setting the `effect` attribute. Some effects change the color properties of the source pixels (such as `ColorAdjust`), others combine multiple images together (such as `Blend`), while still others warp or move the pixels of the source image around (such as `DisplacementMap` or `PerspectiveTransform`). All effects have at least one input defined and the input can be set to another effect to chain the effects together and combine their results, or it can be left unspecified in which case the effect will operate on a graphical rendering of the node it is attached to.

- Class Summary
  Class | Description
  --- | ---
  Blend | An effect that blends the two inputs together using one of the pre-defined `BlendMode`s.
  Bloom | A high-level effect that makes brighter portions of the input image appear to glow, based on a configurable threshold.
  BoxBlur | A blur effect using a simple box filter kernel, with separately configurable sizes in both dimensions, and an iteration parameter that controls the quality of the resulting blur.
  ColorAdjust | An effect that allows for per-pixel adjustments of hue, saturation, brightness, and contrast.
  ColorInput | An effect that renders a rectangular region that is filled ("flooded") with the given `Paint`.
  DisplacementMap | An effect that shifts each pixel by a distance specified by the first two bands of of the specified `FloatMap`.
  DropShadow | A high-level effect that renders a shadow of the given content behind the content with the specified color, radius, and offset.
  Effect | The abstract base class for all effect implementations.
  FloatMap | A buffer that contains floating point data, intended for use as a parameter to effects such as `DisplacementMap`.
  GaussianBlur | A blur effect using a Gaussian convolution kernel, with a configurable radius.
  Glow | A high-level effect that makes the input image appear to glow, based on a configurable threshold.
  ImageInput | A type of source effect that simply passes the given `Image` through, unmodified, as an input to another `Effect`.
  InnerShadow | A high-level effect that renders a shadow inside the edges of the given content with the specified color, radius, and offset.
  Light | The abstract base class for all light implementations.
  Light.Distant | Represents a distant light source.
  Light.Point | Represents a light source at a given position in 3D space.
  Light.Spot | Represents a spot light source at a given position in 3D space, with configurable direction and focus.
  Lighting | An effect that simulates a light source shining on the given content, which can be used to give flat objects a more realistic, three-dimensional appearance.
  MotionBlur | A motion blur effect using a Gaussian convolution kernel, with a configurable radius and angle.
  PerspectiveTransform | An effect that provides non-affine transformation of the input content.
  Reflection | An effect that renders a reflected version of the input below the actual input content.
  SepiaTone | A filter that produces a sepia tone effect, similar to antique photographs.
  Shadow | An effect which creates a monochrome duplicate of an input with blurry edges.

- Enum Summary
  Enum | Description
  --- | ---
  BlendMode | A blending mode defines the manner in which the inputs of a Blend effect are composited together or how a Node is blended into the background of a scene.
  BlurType | Represents the type of blur algorithm that is used to soften a `Shadow` effect.