Package com.ardor3d.renderer.state

Enum Class StencilState.StencilFunction

java.lang.Object

java.lang.Enum<StencilState.StencilFunction>

com.ardor3d.renderer.state.StencilState.StencilFunction

All Implemented Interfaces:

Serializable, Comparable<StencilState.StencilFunction>, Constable

Enclosing class:

StencilState

public static enum StencilState.StencilFunction
extends Enum<StencilState.StencilFunction>

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
Always	A stencil function that always passes.
EqualTo	A stencil function that passes if (ref & mask) == (stencil & mask).
GreaterThan	A stencil function that passes if (ref & mask) > (stencil & mask).
GreaterThanOrEqualTo	A stencil function that passes if (ref & mask) >= (stencil & mask).
LessThan	A stencil function that passes if (ref & mask) < (stencil & mask).
LessThanOrEqualTo	A stencil function that passes if (ref & mask) <= (stencil & mask).
Never	A stencil function that never passes.
NotEqualTo	A stencil function that passes if (ref & mask) !

Method Summary

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

Never

public static final StencilState.StencilFunction Never

A stencil function that never passes.

LessThan

public static final StencilState.StencilFunction LessThan

A stencil function that passes if (ref & mask) < (stencil & mask).

LessThanOrEqualTo

public static final StencilState.StencilFunction LessThanOrEqualTo

A stencil function that passes if (ref & mask) <= (stencil & mask).

GreaterThan

public static final StencilState.StencilFunction GreaterThan

A stencil function that passes if (ref & mask) > (stencil & mask).

GreaterThanOrEqualTo

public static final StencilState.StencilFunction GreaterThanOrEqualTo

A stencil function that passes if (ref & mask) >= (stencil & mask).

EqualTo

public static final StencilState.StencilFunction EqualTo

A stencil function that passes if (ref & mask) == (stencil & mask).

NotEqualTo

public static final StencilState.StencilFunction NotEqualTo

A stencil function that passes if (ref & mask) != (stencil & mask).

Always

public static final StencilState.StencilFunction Always

A stencil function that always passes. (Default)

Method Details

values

public static StencilState.StencilFunction[] 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 StencilState.StencilFunction 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