Package icyllis.modernui.graphics

Enum Class BlendMode

java.lang.Object

java.lang.Enum<BlendMode>

icyllis.modernui.graphics.BlendMode

All Implemented Interfaces:

Serializable, Comparable<BlendMode>, Constable

public enum BlendMode
extends Enum<BlendMode>

Blends are operators that take in two colors (source, destination) and return a new color. Many of these operate the same on all 4 components: red, green, blue, alpha. For these, we just document what happens to one component, rather than naming each one separately.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLEAR	Destination pixels covered by the source are cleared to 0.
COLOR	Replaces hue and saturation of destination with hue and saturation of source, leaving luminosity unchanged.
COLOR_BURN	Makes destination darker to reflect source.
COLOR_DODGE	Makes destination brighter to reflect source.
DARKEN	Retains the smallest component of the source and destination pixels.
DARKER_COLOR	Similar to DARKEN, but darkens on the composite channel, instead of separate RGB color channels.
DIFFERENCE	Subtracts darker from lighter with higher contrast.
DIVIDE	Divides the destination pixels by the source pixels and saturates the result.
DST	The source pixels are discarded, leaving the destination intact.
DST_ATOP	Discards the destination pixels that are not covered by source pixels.
DST_IN	Keeps the destination pixels that cover source pixels, discards the remaining source and destination pixels.
DST_OUT	Keeps the destination pixels that are not covered by source pixels.
DST_OVER	The source pixels are drawn behind the destination pixels.
EXCLUSION	Subtracts darker from lighter with lower contrast.
HARD_LIGHT	Makes destination lighter or darker, depending on source.
HARD_MIX	Adds two images together, setting each color channel value to either 0 or 1.
HUE	Replaces hue of destination with hue of source, leaving saturation and luminosity unchanged.
LIGHTEN	Retains the largest component of the source and destination pixel.
LIGHTER_COLOR	Similar to LIGHTEN, but lightens on the composite channel, instead of separate RGB color channels.
LINEAR_BURN	Darkens the destination pixels to reflect the source pixels while also increasing contrast.
LINEAR_DODGE	Lightens the destination pixels to reflect the source pixels while also increasing contrast.
LINEAR_LIGHT	Burns or dodges colors by changing brightness, depending on the blend color.
LUMINOSITY	Replaces luminosity of destination with luminosity of source, leaving hue and saturation unchanged.
MINUS	Subtracts the source pixels from the destination pixels, without alpha blending.
MINUS_CLAMPED	Subtracts the source pixels from the destination pixels and saturates the result, without alpha blending.
MODULATE	Multiplies the source and destination pixels.
MULTIPLY	Multiplies the source and destination pixels. This is MODULATE with alpha blending.
OVERLAY	Multiplies or screens the source and destination depending on the destination color.
PIN_LIGHT	Conditionally replaces destination pixels with source pixels depending on the brightness of the source pixels.
PLUS	Adds the source pixels to the destination pixels. For floating-point textures, color components may be greater than 1.0.
PLUS_CLAMPED	Adds the source pixels to the destination pixels and saturates the result. For unsigned fixed-point textures, this is the same as PLUS.
SATURATION	Replaces saturation of destination saturation hue of source, leaving hue and luminosity unchanged.
SCREEN	Adds the source and destination pixels, then subtracts the source pixels multiplied by the destination.
SOFT_LIGHT	Makes destination lighter or darker, depending on source.
SRC	The source pixels replace the destination pixels.
SRC_ATOP	Discards the source pixels that do not cover destination pixels.
SRC_IN	Keeps the source pixels that cover the destination pixels, discards the remaining source and destination pixels.
SRC_OUT	Keeps the source pixels that do not cover destination pixels.
SRC_OVER	The source pixels are drawn over the destination pixels.
SUBTRACT	Subtracts the source pixels from the destination pixels and saturates the result, with alpha blending.
VIVID_LIGHT	Burns or dodges colors by changing contrast, depending on the blend color.
XOR	Discards the source and destination pixels where source pixels cover destination pixels.

Field Summary

Fields

Modifier and Type	Field	Description
static final BlendMode	ADD	Name alias of LINEAR_DODGE.

Method Summary

Modifier and Type	Method	Description
static BlendMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BlendMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLEAR

public static final BlendMode CLEAR

Destination pixels covered by the source are cleared to 0.

a_out = 0

C_out = 0

SRC

public static final BlendMode SRC

The source pixels replace the destination pixels.

a_out = a_src

C_out = C_src

DST

public static final BlendMode DST

The source pixels are discarded, leaving the destination intact.

a_out = a_dst

C_out = C_dst

SRC_OVER

public static final BlendMode SRC_OVER

The source pixels are drawn over the destination pixels.

a_out = a_src + (1 - a_src) * a_dst

C_out = C_src + (1 - a_src) * C_dst

DST_OVER

public static final BlendMode DST_OVER

The source pixels are drawn behind the destination pixels.

a_out = a_dst + (1 - a_dst) * a_src

C_out = C_dst + (1 - a_dst) * C_src

SRC_IN

public static final BlendMode SRC_IN

Keeps the source pixels that cover the destination pixels, discards the remaining source and destination pixels.

a_out = a_src * a_dst

C_out = C_src * a_dst

DST_IN

public static final BlendMode DST_IN

Keeps the destination pixels that cover source pixels, discards the remaining source and destination pixels.

a_out = a_dst * a_src

C_out = C_dst * a_src

SRC_OUT

public static final BlendMode SRC_OUT

Keeps the source pixels that do not cover destination pixels. Discards source pixels that cover destination pixels. Discards all destination pixels.

a_out = (1 - a_dst) * a_src

C_out = (1 - a_dst) * C_src

DST_OUT

public static final BlendMode DST_OUT

Keeps the destination pixels that are not covered by source pixels. Discards destination pixels that are covered by source pixels. Discards all source pixels.

a_out = (1 - a_src) * a_dst

C_out = (1 - a_src) * C_dst

SRC_ATOP

public static final BlendMode SRC_ATOP

Discards the source pixels that do not cover destination pixels. Draws remaining source pixels over destination pixels.

a_out = a_dst

C_out = a_dst * C_src + (1 - a_src) * C_dst

DST_ATOP

public static final BlendMode DST_ATOP

Discards the destination pixels that are not covered by source pixels. Draws remaining destination pixels over source pixels.

a_out = a_src

C_out = a_src * C_dst + (1 - a_dst) * C_src

XOR

public static final BlendMode XOR

Discards the source and destination pixels where source pixels cover destination pixels. Draws remaining source pixels.

a_out = (1 - a_dst) * a_src + (1 - a_src) * a_dst

C_out = (1 - a_dst) * C_src + (1 - a_src) * C_dst

PLUS

public static final BlendMode PLUS

Adds the source pixels to the destination pixels.

For floating-point textures, color components may be greater than 1.0.

a_out = a_src + a_dst

C_out = C_src + C_dst

See Also:

• PLUS_CLAMPED
• LINEAR_DODGE

PLUS_CLAMPED

public static final BlendMode PLUS_CLAMPED

Adds the source pixels to the destination pixels and saturates the result.

For unsigned fixed-point textures, this is the same as PLUS. This is an advanced blend equation.

a_out = max(0, min(a_src + a_dst, 1))

C_out = max(0, min(C_src + C_dst, 1))

See Also:

• PLUS
• LINEAR_DODGE

MINUS

public static final BlendMode MINUS

Subtracts the source pixels from the destination pixels, without alpha blending. For floating-point textures, color components may be less than 0.0.

a_out = a_dst - a_src

C_out = C_dst - C_src

See Also:

• MINUS_CLAMPED
• SUBTRACT

MINUS_CLAMPED

public static final BlendMode MINUS_CLAMPED

Subtracts the source pixels from the destination pixels and saturates the result, without alpha blending. For unsigned fixed-point textures, this is the same as MINUS. This is an advanced blend equation.

a_out = max(0, min(a_dst - a_src, 1))

C_out = max(0, min(C_dst - C_src, 1))

See Also:

• MINUS
• SUBTRACT

MODULATE

public static final BlendMode MODULATE

Multiplies the source and destination pixels.

a_out = a_src * a_dst

C_out = C_src * C_dst

See Also:

• MULTIPLY

MULTIPLY

public static final BlendMode MULTIPLY

Multiplies the source and destination pixels.

This is MODULATE with alpha blending. If both the source and destination are opaque, then this is the same as MODULATE. This is an advanced blend equation.

a_out = a_src + a_dst - a_src * a_dst

C_out = C_src * C_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

See Also:

• MODULATE

SCREEN

public static final BlendMode SCREEN

Adds the source and destination pixels, then subtracts the source pixels multiplied by the destination.

a_out = a_src + a_dst - a_src * a_dst

C_out = C_src + C_dst - C_src * C_dst

OVERLAY

public static final BlendMode OVERLAY

Multiplies or screens the source and destination depending on the destination color.

a_out = a_src + a_dst - a_src * a_dst

if C_dst ≤ 0.5 * a_dst:
C_out = 2 * C_src * C_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

otherwise:
C_out = a_src * a_dst - 2 * (a_src - C_src) * (a_dst - C_dst) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

DARKEN

public static final BlendMode DARKEN

Retains the smallest component of the source and destination pixels.

a_out = a_src + a_dst - a_src * a_dst

C_out = min(C_src, C_dst) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

LIGHTEN

public static final BlendMode LIGHTEN

Retains the largest component of the source and destination pixel.

a_out = a_src + a_dst - a_src * a_dst

C_out = max(C_src, C_dst) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

COLOR_DODGE

public static final BlendMode COLOR_DODGE

Makes destination brighter to reflect source.

a_out = a_src + a_dst - a_src * a_dst

if C_dst ≤ 0:
C_out = C_src * (1 - a_dst)

if C_src ≥ a_src:
C_out = a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

otherwise:
C_out = a_src * min(a_dst, C_dst * a_src / (a_src - C_src)) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

COLOR_BURN

public static final BlendMode COLOR_BURN

Makes destination darker to reflect source.

a_out = a_src + a_dst - a_src * a_dst

if C_dst ≥ a_dst:
C_out = a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

if C_src ≤ 0:
C_out = C_src * (1 - a_dst)

otherwise:
C_out = a_src * (a_dst - min(a_dst, (a_dst - C_dst) * a_src / C_dst)) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

HARD_LIGHT

public static final BlendMode HARD_LIGHT

Makes destination lighter or darker, depending on source.

a_out = a_src + a_dst - a_src * a_dst

if C_src ≤ 0.5 * a_src:
C_out = 2 * C_src * C_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

otherwise:
C_out = a_src * a_dst - 2 * (a_src - C_src) * (a_dst - C_dst) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

SOFT_LIGHT

public static final BlendMode SOFT_LIGHT

Makes destination lighter or darker, depending on source.

a_out = a_src + a_dst - a_src * a_dst

if C_src ≤ 0.5 * a_src:
C_out = C_dst * C_dst * (a_src - 2 * C_src) / a_dst + (1 - a_dst) * C_src + C_dst * (2 * C_src + 1 - a_src)

if C_dst ≤ 0.25 * a_dst:
C_out = (a_dst * a_dst * (C_src + C_dst * (6 * C_src - 3 * a_src + 1)) + 12 * a_dst * C_dst * C_dst * (a_src - 2 * C_src) - 16 * C_dst * C_dst * C_dst * (a_src - 2 * C_src) - a_dst * a_dst * a_dst * C_src) / a_dst * a_dst

otherwise:
C_out = C_dst * (a_src - 2 * C_src + 1) + C_src * (1 - a_dst) - sqrt(C_dst * a_dst) * (a_src - 2 * C_src)

DIFFERENCE

public static final BlendMode DIFFERENCE

Subtracts darker from lighter with higher contrast.

a_out = a_src + a_dst - a_src * a_dst

C_out = C_src + C_dst - 2 * min(C_src * a_dst, C_dst * a_src)

EXCLUSION

public static final BlendMode EXCLUSION

Subtracts darker from lighter with lower contrast.

a_out = a_src + a_dst - a_src * a_dst

C_out = C_src + C_dst - 2 * C_src * C_dst

SUBTRACT

public static final BlendMode SUBTRACT

Subtracts the source pixels from the destination pixels and saturates the result, with alpha blending. If both the source and destination are opaque, then this is the same as MINUS_CLAMPED. This is a custom blend equation.

a_out = a_src + a_dst - a_src * a_dst

if C_dst / a_dst - C_src / a_src ≥ 0:
C_out = C_src + C_dst - 2 * C_src * a_dst

otherwise:
C_out = (1 - a_dst) * C_src + (1 - a_src) * C_dst

See Also:

• MINUS
• MINUS_CLAMPED

DIVIDE

public static final BlendMode DIVIDE

Divides the destination pixels by the source pixels and saturates the result. For negative and NaN values, the result color is black (XOR). This is a custom blend equation.

a_out = a_src + a_dst - a_src * a_dst

C_out = pin((C_dst * a_src) / (C_src * a_dst), 0, 1) * a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

LINEAR_DODGE

public static final BlendMode LINEAR_DODGE

Lightens the destination pixels to reflect the source pixels while also increasing contrast. This is PLUS_CLAMPED with alpha blending. If both the source and destination are opaque, then this is the same as PLUS_CLAMPED. This is an extended advanced blend equation.

a_out = a_src + a_dst - a_src * a_dst

if C_src / a_src + C_dst / a_dst ≤ 1:
C_out = C_src + C_dst

otherwise:
C_out = a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

See Also:

• PLUS
• PLUS_CLAMPED

LINEAR_BURN

public static final BlendMode LINEAR_BURN

Darkens the destination pixels to reflect the source pixels while also increasing contrast. This is an extended advanced blend equation.

a_out = a_src + a_dst - a_src * a_dst

if C_src / a_src + C_dst / a_dst > 1:
C_out = C_src + C_dst - a_src * a_dst

otherwise:
C_out = (1 - a_dst) * C_src + (1 - a_src) * C_dst

VIVID_LIGHT

public static final BlendMode VIVID_LIGHT

Burns or dodges colors by changing contrast, depending on the blend color. This is an extended advanced blend equation.

a_out = a_src + a_dst - a_src * a_dst

if C_src ≤ 0:
C_out = C_dst * (1 - a_src)

if C_src < 0.5 * a_src:
C_out = a_src * (a_dst - min(a_dst, (a_dst - C_dst) * a_src / (2 * C_dst))) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

if C_src ≥ a_src:
C_out = a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

otherwise:
C_out = a_src * min(a_dst, C_dst * a_src / (2 * (a_src - C_src))) + (1 - a_dst) * C_src + (1 - a_src) * C_dst

LINEAR_LIGHT

public static final BlendMode LINEAR_LIGHT

Burns or dodges colors by changing brightness, depending on the blend color. This is an extended advanced blend equation.

a_out = a_src + a_dst - a_src * a_dst

if 2 * C_src / a_src + C_dst / a_dst > 2:
C_out = a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

if 2 * C_src / a_src + C_dst / a_dst ≤ 1:
C_out = (1 - a_dst) * C_src + (1 - a_src) * C_dst

otherwise:
C_out = 2 * C_src * a_dst + C_dst * a_src - a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

PIN_LIGHT

public static final BlendMode PIN_LIGHT

Conditionally replaces destination pixels with source pixels depending on the brightness of the source pixels. This is an extended advanced blend equation.

a_out = a_src + a_dst - a_src * a_dst

if 2 * C_src / a_src - C_dst / a_dst > 1 && C_src < 0.5 * a_src:
C_out = (1 - a_dst) * C_src + (1 - a_src) * C_dst

if 2 * C_src / a_src - C_dst / a_dst > 1 && C_src ≥ 0.5 * a_src:
C_out = 2 * C_src * a_dst - a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

if 2 * C_src / a_src - C_dst / a_dst ≤ 1 && C_src * a_dst < 0.5 * C_dst * a_src:
C_out = 2 * C_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

otherwise:
C_out = C_dst * a_src + (1 - a_dst) * C_src + (1 - a_src) * C_dst

HARD_MIX

public static final BlendMode HARD_MIX

Adds two images together, setting each color channel value to either 0 or 1. This is an extended advanced blend equation.

a_out = a_src + a_dst - a_src * a_dst

if C_src / a_src + C_dst / a_dst < 1:
C_out = (1 - a_dst) * C_src + (1 - a_src) * C_dst

otherwise:
C_out = a_src * a_dst + (1 - a_dst) * C_src + (1 - a_src) * C_dst

DARKER_COLOR

public static final BlendMode DARKER_COLOR

Similar to DARKEN, but darkens on the composite channel, instead of separate RGB color channels. It compares the source and destination color, and keep the one with lower luminosity between the two.

if lum(C_src) ≤ lum(C_dst):
Equivalent to SRC_OVER

otherwise:
Equivalent to DST_OVER

LIGHTER_COLOR

public static final BlendMode LIGHTER_COLOR

Similar to LIGHTEN, but lightens on the composite channel, instead of separate RGB color channels. It compares the source and destination color, and keep the one with higher luminosity between the two.

if lum(C_src) ≥ lum(C_dst):
Equivalent to SRC_OVER

otherwise:
Equivalent to DST_OVER

HUE

public static final BlendMode HUE

Replaces hue of destination with hue of source, leaving saturation and luminosity unchanged.

SATURATION

public static final BlendMode SATURATION

Replaces saturation of destination saturation hue of source, leaving hue and luminosity unchanged.

COLOR

public static final BlendMode COLOR

Replaces hue and saturation of destination with hue and saturation of source, leaving luminosity unchanged.

LUMINOSITY

public static final BlendMode LUMINOSITY

Replaces luminosity of destination with luminosity of source, leaving hue and saturation unchanged.

Field Details

ADD

public static final BlendMode ADD

Name alias of LINEAR_DODGE.

Method Details

values

public static BlendMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BlendMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null