Package com.ardor3d.renderer.state

Enum Class BlendState.DestinationFunction

java.lang.Object

java.lang.Enum<BlendState.DestinationFunction>

com.ardor3d.renderer.state.BlendState.DestinationFunction

All Implemented Interfaces:

Serializable, Comparable<BlendState.DestinationFunction>, Constable

Enclosing class:

BlendState

public static enum BlendState.DestinationFunction
extends Enum<BlendState.DestinationFunction>

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
ConstantAlpha	The destination value of the blend function is the value of the constant color's alpha.
ConstantColor	The destination value of the blend function is the value of the constant color.
DestinationAlpha	The destination value of the blend function is the destination alpha value.
One	The destination value of the blend function is all ones.
OneMinusConstantAlpha	The destination value of the blend function is 1 minus the value of the constant color's alpha. (1-Ac, 1-Ac, 1-Ac, 1-Ac) If color is not set, black with alpha = 0 is used.
OneMinusConstantColor	The destination value of the blend function is 1 minus the value of the constant color. (1-Rc, 1-Gc, 1-Bc, 1-Ac) If color is not set, black with alpha = 0 is used.
OneMinusDestinationAlpha	The destination value of the blend function is 1 - the destination alpha value.
OneMinusSourceAlpha	The destination value of the blend function is 1 - the source alpha value.
OneMinusSourceColor	The destination value of the blend function is 1 - the source color.
SourceAlpha	The destination value of the blend function is the source alpha value.
SourceColor	The destination value of the blend function is the source color.
Zero	The destination value of the blend function is all zeros.

Method Summary

Modifier and Type	Method	Description
boolean	usesConstantColor()
static BlendState.DestinationFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BlendState.DestinationFunction[]	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

Zero

public static final BlendState.DestinationFunction Zero

The destination value of the blend function is all zeros.

One

public static final BlendState.DestinationFunction One

The destination value of the blend function is all ones.

SourceColor

public static final BlendState.DestinationFunction SourceColor

The destination value of the blend function is the source color.

OneMinusSourceColor

public static final BlendState.DestinationFunction OneMinusSourceColor

The destination value of the blend function is 1 - the source color.

SourceAlpha

public static final BlendState.DestinationFunction SourceAlpha

The destination value of the blend function is the source alpha value.

OneMinusSourceAlpha

public static final BlendState.DestinationFunction OneMinusSourceAlpha

The destination value of the blend function is 1 - the source alpha value.

DestinationAlpha

public static final BlendState.DestinationFunction DestinationAlpha

The destination value of the blend function is the destination alpha value.

OneMinusDestinationAlpha

public static final BlendState.DestinationFunction OneMinusDestinationAlpha

The destination value of the blend function is 1 - the destination alpha value.

ConstantColor

public static final BlendState.DestinationFunction ConstantColor

The destination value of the blend function is the value of the constant color. (Rc, Gc, Bc, Ac) If not set, black with alpha = 0 is used. If not supported, falls back to One.

OneMinusConstantColor

public static final BlendState.DestinationFunction OneMinusConstantColor

The destination value of the blend function is 1 minus the value of the constant color. (1-Rc, 1-Gc, 1-Bc, 1-Ac) If color is not set, black with alpha = 0 is used. If not supported, falls back to One.

ConstantAlpha

public static final BlendState.DestinationFunction ConstantAlpha

The destination value of the blend function is the value of the constant color's alpha. (Ac, Ac, Ac, Ac) If not set, black with alpha = 0 is used. If not supported, falls back to One.

OneMinusConstantAlpha

public static final BlendState.DestinationFunction OneMinusConstantAlpha

The destination value of the blend function is 1 minus the value of the constant color's alpha. (1-Ac, 1-Ac, 1-Ac, 1-Ac) If color is not set, black with alpha = 0 is used. If not supported, falls back to One.

Method Details

values

public static BlendState.DestinationFunction[] 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 BlendState.DestinationFunction 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

usesConstantColor

public boolean usesConstantColor()