Microsoft.Xna.Framework.Graphics
Enum BlendFunction

java.lang.Object
  java.lang.Enum<BlendFunction>
      Microsoft.Xna.Framework.Graphics.BlendFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BlendFunction>

public enum BlendFunction
extends java.lang.Enum<BlendFunction>

Defines how to combine a source color with the destination color already on the render target for color blending.

Author:

Halofreak1990

Enum Constant Summary

Add
The result is the destination added to the source.

Max
The result is the maximum of the source and destination.

Min
The result is the minimum of the source and destination.

ReverseSubtract
The result is the source subtracted from the destination.

Subtract
The result is the destination subtracted from the source.

Method Summary

static BlendFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BlendFunction[]	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

Add

public static final BlendFunction Add

The result is the destination added to the source. Result = (Source Color * Source Blend) + (Destination Color * Destination Blend)

Subtract

public static final BlendFunction Subtract

The result is the destination subtracted from the source. Result = (Source Color * Source Blend) - (Destination Color * Destination Blend)

ReverseSubtract

public static final BlendFunction ReverseSubtract

The result is the source subtracted from the destination. Result = (Destination Color * Destination Blend) - (Source Color * Source Blend)

Min

public static final BlendFunction Min

The result is the minimum of the source and destination. Result = min((Source Color * Source Blend), (Destination Color * Destination Blend))

Max

public static final BlendFunction Max

The result is the maximum of the source and destination. Result = max((Source Color * Source Blend), (Destination Color * Destination Blend))

Method Detail

values

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

Returns:

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

valueOf

public static BlendFunction 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