agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r3.jar)

Enum BlendingEquation

java.lang.Object

java.lang.Enum<BlendingEquation>

agi.foundation.graphics.advanced.BlendingEquation

All Implemented Interfaces:

Enumeration, Serializable, Comparable<BlendingEquation>

public enum BlendingEquation
extends Enum<BlendingEquation>
implements Enumeration

The operation that will be used when combining the source and destination values during blending.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLEND_EQUATION_ADD Add source and destination colors
BLEND_EQUATION_MAX Select the maximum value for each color component
BLEND_EQUATION_MIN Select the minimum value for each color component
BLEND_EQUATION_REVERSE_SUBTRACT Subtract destination color from source color
BLEND_EQUATION_SUBTRACT Subtract source color from destination color

Method Summary

Modifier and Type	Method and Description
static BlendingEquation	getDefault() Get the enum constant that is considered to be the default.
static BlendingEquation	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static BlendingEquation	valueOf(String name) Returns the enum constant of this type with the specified name.
static BlendingEquation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLEND_EQUATION_ADD

public static final BlendingEquation BLEND_EQUATION_ADD

Add source and destination colors

BLEND_EQUATION_SUBTRACT

public static final BlendingEquation BLEND_EQUATION_SUBTRACT

Subtract source color from destination color

BLEND_EQUATION_REVERSE_SUBTRACT

public static final BlendingEquation BLEND_EQUATION_REVERSE_SUBTRACT

Subtract destination color from source color

BLEND_EQUATION_MIN

public static final BlendingEquation BLEND_EQUATION_MIN

Select the minimum value for each color component

BLEND_EQUATION_MAX

public static final BlendingEquation BLEND_EQUATION_MAX

Select the maximum value for each color component

Method Detail

values

public static BlendingEquation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BlendingEquation c : BlendingEquation.values())
    System.out.println(c);

Returns:

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

valueOf

public static BlendingEquation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static BlendingEquation getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static BlendingEquation getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.