com.jme.scene.state
Enum BlendState.SourceFunction

java.lang.Object
  extended by java.lang.Enum<BlendState.SourceFunction>
      extended by com.jme.scene.state.BlendState.SourceFunction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<BlendState.SourceFunction>
Enclosing class:
BlendState

public static enum BlendState.SourceFunction
extends java.lang.Enum<BlendState.SourceFunction>


Enum Constant Summary
ConstantAlpha
          The source value of the blend function is the value of the constant color's alpha.
ConstantColor
          The source value of the blend function is the value of the constant color.
DestinationAlpha
          The source value of the blend function is the destination alpha.
DestinationColor
          The source value of the blend function is the destination color.
One
          The source value of the blend function is all ones.
OneMinusConstantAlpha
          The source value of the blend function is 1 minus the value of the constant color's alpha.
OneMinusConstantColor
          The source value of the blend function is 1 minus the value of the constant color.
OneMinusDestinationAlpha
          The source value of the blend function is 1 - the destination alpha.
OneMinusDestinationColor
          The source value of the blend function is 1 - the destination color.
OneMinusSourceAlpha
          The source value of the blend function is 1 - the source alpha value.
SourceAlpha
          The source value of the blend function is the source alpha value.
SourceAlphaSaturate
          The source value of the blend function is the minimum of alpha or 1 - alpha.
Zero
          The source value of the blend function is all zeros.
 
Method Summary
 boolean usesConstantColor()
           
static BlendState.SourceFunction valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static BlendState.SourceFunction[] 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

Zero

public static final BlendState.SourceFunction Zero
The source value of the blend function is all zeros.


One

public static final BlendState.SourceFunction One
The source value of the blend function is all ones.


DestinationColor

public static final BlendState.SourceFunction DestinationColor
The source value of the blend function is the destination color.


OneMinusDestinationColor

public static final BlendState.SourceFunction OneMinusDestinationColor
The source value of the blend function is 1 - the destination color.


SourceAlpha

public static final BlendState.SourceFunction SourceAlpha
The source value of the blend function is the source alpha value.


OneMinusSourceAlpha

public static final BlendState.SourceFunction OneMinusSourceAlpha
The source value of the blend function is 1 - the source alpha value.


DestinationAlpha

public static final BlendState.SourceFunction DestinationAlpha
The source value of the blend function is the destination alpha.


OneMinusDestinationAlpha

public static final BlendState.SourceFunction OneMinusDestinationAlpha
The source value of the blend function is 1 - the destination alpha.


SourceAlphaSaturate

public static final BlendState.SourceFunction SourceAlphaSaturate
The source value of the blend function is the minimum of alpha or 1 - alpha.


ConstantColor

public static final BlendState.SourceFunction ConstantColor
The source 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.SourceFunction OneMinusConstantColor
The source 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.SourceFunction ConstantAlpha
The source 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.SourceFunction OneMinusConstantAlpha
The source 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 Detail

values

public static BlendState.SourceFunction[] 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 (BlendState.SourceFunction c : BlendState.SourceFunction.values())
    System.out.println(c);

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

valueOf

public static BlendState.SourceFunction valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

usesConstantColor

public boolean usesConstantColor()