Top Description Fields Constructors Methods
javafx.scene.effect

public final Enum BlendMode

extends Enum<BlendMode>
Class Inheritance

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.
import javafx.scene.*;
import javafx.scene.effect.*;
import javafx.scene.paint.*;
import javafx.scene.shape.*;

Rectangle r = new Rectangle();
r.setX(50);
r.setY(50);
r.setWidth(50);
r.setHeight(50);
r.setFill(Color.BLUE);

Circle c = new Circle();
c.setFill(Color.rgb(255, 0, 0, 0.5));
c.setCenterX(50);
c.setCenterY(50);
c.setRadius(25);
c.setBlendMode(BlendMode.MULTIPLY);

Group g = new Group();
g.getChildren().add(r);
g.getChildren().add(c);
Since
JavaFX 2.0

Field Summary

Modifier and TypeField and Description
public static final BlendMode
ADD

The color and alpha components from the top input are added to those from the bottom input.

public static final BlendMode
BLUE

The blue component of the bottom input is replaced with the blue component of the top input; the other color components are unaffected.

public static final BlendMode
COLOR_BURN

The inverse of the bottom input color components are divided by the top input color components, all of which is then inverted to produce the resulting color.

public static final BlendMode
COLOR_DODGE

The bottom input color components are divided by the inverse of the top input color components to produce the resulting color.

public static final BlendMode
DARKEN

The darker of the color components from the two inputs are selected to produce the resulting color.

public static final BlendMode
DIFFERENCE

The darker of the color components from the two inputs are subtracted from the lighter ones to produce the resulting color.

public static final BlendMode
EXCLUSION

The color components from the two inputs are multiplied and doubled, and then subtracted from the sum of the bottom input color components, to produce the resulting color.

public static final BlendMode
GREEN

The green component of the bottom input is replaced with the green component of the top input; the other color components are unaffected.

public static final BlendMode
HARD_LIGHT

The input color components are either multiplied or screened, depending on the top input color.

public static final BlendMode
LIGHTEN

The lighter of the color components from the two inputs are selected to produce the resulting color.

public static final BlendMode
MULTIPLY

The color components from the first input are multiplied with those from the second input.

public static final BlendMode
OVERLAY

The input color components are either multiplied or screened, depending on the bottom input color.

public static final BlendMode
RED

The red component of the bottom input is replaced with the red component of the top input; the other color components are unaffected.

public static final BlendMode
SCREEN

The color components from both of the inputs are inverted, multiplied with each other, and that result is again inverted to produce the resulting color.

public static final BlendMode
SOFT_LIGHT

The input color components are either darkened or lightened, depending on the top input color.

public static final BlendMode
SRC_ATOP

The part of the top input lying inside of the bottom input is blended with the bottom input.

public static final BlendMode
SRC_OVER

The top input is blended over the bottom input.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static BlendMode
public static BlendMode[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ADDback to summary
public static final BlendMode ADD

The color and alpha components from the top input are added to those from the bottom input. The result is clamped to 1.0 if it exceeds the logical maximum of 1.0.

Notes:

  • This mode is commutative (ordering of inputs does not matter).
  • This mode is sometimes referred to as "linear dodge" in imaging software packages.
BLUEback to summary
public static final BlendMode BLUE

The blue component of the bottom input is replaced with the blue component of the top input; the other color components are unaffected. The alpha components are blended according to the SRC_OVER equation.

COLOR_BURNback to summary
public static final BlendMode COLOR_BURN

The inverse of the bottom input color components are divided by the top input color components, all of which is then inverted to produce the resulting color. The alpha components are blended according to the SRC_OVER equation.

COLOR_DODGEback to summary
public static final BlendMode COLOR_DODGE

The bottom input color components are divided by the inverse of the top input color components to produce the resulting color. The alpha components are blended according to the SRC_OVER equation.

DARKENback to summary
public static final BlendMode DARKEN

The darker of the color components from the two inputs are selected to produce the resulting color. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is commutative (ordering of inputs does not matter).
  • This mode is the mathematical opposite of the LIGHTEN mode.
DIFFERENCEback to summary
public static final BlendMode DIFFERENCE

The darker of the color components from the two inputs are subtracted from the lighter ones to produce the resulting color. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is commutative (ordering of inputs does not matter).
  • This mode can be used to invert parts of the bottom input image, or to quickly compare two images (equal pixels will result in black).
  • Rendering with a completely white top input inverts the bottom input; rendering with a completely black top input produces a result equivalent to the bottom input.
EXCLUSIONback to summary
public static final BlendMode EXCLUSION

The color components from the two inputs are multiplied and doubled, and then subtracted from the sum of the bottom input color components, to produce the resulting color. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is commutative (ordering of inputs does not matter).
  • This mode can be used to invert parts of the bottom input.
  • This mode produces results that are similar to those of DIFFERENCE, except with lower contrast.
  • Rendering with a completely white top input inverts the bottom input; rendering with a completely black top input produces a result equivalent to the bottom input.
GREENback to summary
public static final BlendMode GREEN

The green component of the bottom input is replaced with the green component of the top input; the other color components are unaffected. The alpha components are blended according to the SRC_OVER equation.

HARD_LIGHTback to summary
public static final BlendMode HARD_LIGHT

The input color components are either multiplied or screened, depending on the top input color. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is a combination of SCREEN and MULTIPLY, depending on the top input color.
  • This mode is the mathematical opposite of the OVERLAY mode.
LIGHTENback to summary
public static final BlendMode LIGHTEN

The lighter of the color components from the two inputs are selected to produce the resulting color. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is commutative (ordering of inputs does not matter).
  • This mode is the mathematical opposite of the DARKEN mode.
MULTIPLYback to summary
public static final BlendMode MULTIPLY

The color components from the first input are multiplied with those from the second input. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is commutative (ordering of inputs does not matter).
  • This mode is the mathematical opposite of the SCREEN mode.
  • The resulting color is always at least as dark as either of the input colors.
  • Rendering with a completely black top input produces black; rendering with a completely white top input produces a result equivalent to the bottom input.
OVERLAYback to summary
public static final BlendMode OVERLAY

The input color components are either multiplied or screened, depending on the bottom input color. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is a combination of SCREEN and MULTIPLY, depending on the bottom input color.
  • This mode is the mathematical opposite of the HARD_LIGHT mode.
  • In this mode, the top input colors "overlay" the bottom input while preserving highlights and shadows of the latter.
REDback to summary
public static final BlendMode RED

The red component of the bottom input is replaced with the red component of the top input; the other color components are unaffected. The alpha components are blended according to the SRC_OVER equation.

SCREENback to summary
public static final BlendMode SCREEN

The color components from both of the inputs are inverted, multiplied with each other, and that result is again inverted to produce the resulting color. The alpha components are blended according to the SRC_OVER equation.

Notes:

  • This mode is commutative (ordering of inputs does not matter).
  • This mode is the mathematical opposite of the MULTIPLY mode.
  • The resulting color is always at least as light as either of the input colors.
  • Rendering with a completely white top input produces white; rendering with a completely black top input produces a result equivalent to the bottom input.
SOFT_LIGHTback to summary
public static final BlendMode SOFT_LIGHT

The input color components are either darkened or lightened, depending on the top input color. The alpha components are blended according to the SRC_OVER equation.

Notes

  • This mode is similar to OVERLAY, but generally produces "lighter" results than OVERLAY.
SRC_ATOPback to summary
public static final BlendMode SRC_ATOP

The part of the top input lying inside of the bottom input is blended with the bottom input. (Equivalent to the Porter-Duff "source atop destination" rule.)

SRC_OVERback to summary
public static final BlendMode SRC_OVER

The top input is blended over the bottom input. (Equivalent to the Porter-Duff "source over destination" rule.)

Constructor Detail

BlendModeback to summary
private BlendMode()

Method Detail

valueOfback to summary
public static BlendMode valueOf(String name)
valuesback to summary
public static BlendMode[] values()