com.jme3.material

Enum RenderState.TestFunction

java.lang.Object

java.lang.Enum<RenderState.TestFunction>

com.jme3.material.RenderState.TestFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RenderState.TestFunction>

Enclosing class:

RenderState

public static enum RenderState.TestFunction
extends java.lang.Enum<RenderState.TestFunction>

TestFunction specifies the testing function for stencil test function.

The reference value given in the stencil command is the input value while the reference is the value already in the stencil buffer.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Always The test always passes
Equal The test succeeds if the input value is equal to the reference value.
Greater The test succeeds if the input value is greater than the reference value.
GreaterOrEqual The test succeeds if the input value is greater than or equal to the reference value.
Less The test succeeds if the input value is less than the reference value.
LessOrEqual The test succeeds if the input value is less than or equal to the reference value.
Never The test always fails
NotEqual The test succeeds if the input value does not equal the reference value.

Method Summary

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

Never

public static final RenderState.TestFunction Never

The test always fails

Equal

public static final RenderState.TestFunction Equal

The test succeeds if the input value is equal to the reference value.

Less

public static final RenderState.TestFunction Less

The test succeeds if the input value is less than the reference value.

LessOrEqual

public static final RenderState.TestFunction LessOrEqual

The test succeeds if the input value is less than or equal to the reference value.

Greater

public static final RenderState.TestFunction Greater

The test succeeds if the input value is greater than the reference value.

GreaterOrEqual

public static final RenderState.TestFunction GreaterOrEqual

The test succeeds if the input value is greater than or equal to the reference value.

NotEqual

public static final RenderState.TestFunction NotEqual

The test succeeds if the input value does not equal the reference value.

Always

public static final RenderState.TestFunction Always

The test always passes

Method Detail

values

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

Returns:

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

valueOf

public static RenderState.TestFunction 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