Microsoft.Xna.Framework.Graphics

Enum CompareFunction

java.lang.Object

java.lang.Enum<CompareFunction>

Microsoft.Xna.Framework.Graphics.CompareFunction

All Implemented Interfaces:

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

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

Defines comparison functions that can be chosen for alpha, stencil, or depth-buffer tests.

Author:

Halofreak1990

Enum Constant Summary

Enum Constants

Enum Constant and Description
Always Always pass the test.
Equal Accept the new pixel if its value is equal to the value of the current pixel.
Greater Accept the new pixel if its value is greater than the value of the current pixel.
GreaterEqual Accept the new pixel if its value is greater than or equal to the value of the current pixel.
Less Accept the new pixel if its value is less than the value of the current pixel.
LessEqual Accept the new pixel if its value is less than or equal to the value of the current pixel.
Never Always fail the test.
NotEqual Accept the new pixel if its value is not equal to the value of the current pixel.

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue()
static CompareFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CompareFunction[]	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

Always

public static final CompareFunction Always

Always pass the test.

Never

public static final CompareFunction Never

Always fail the test.

Less

public static final CompareFunction Less

Accept the new pixel if its value is less than the value of the current pixel.

LessEqual

public static final CompareFunction LessEqual

Accept the new pixel if its value is less than or equal to the value of the current pixel.

Equal

public static final CompareFunction Equal

Accept the new pixel if its value is equal to the value of the current pixel.

GreaterEqual

public static final CompareFunction GreaterEqual

Accept the new pixel if its value is greater than or equal to the value of the current pixel.

Greater

public static final CompareFunction Greater

Accept the new pixel if its value is greater than the value of the current pixel.

NotEqual

public static final CompareFunction NotEqual

Accept the new pixel if its value is not equal to the value of the current pixel.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()