Package com.ardor3d.renderer.state

Enum Class StencilState.StencilOperation

java.lang.Object

java.lang.Enum<StencilState.StencilOperation>

com.ardor3d.renderer.state.StencilState.StencilOperation

All Implemented Interfaces:

Serializable, Comparable<StencilState.StencilOperation>, Constable

Enclosing class:

StencilState

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

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
Decrement	A stencil function result that decrements the current stencil buffer value.
DecrementWrap	A stencil function result that decrements the current stencil buffer and wraps around to the highest stencil value if it reaches the min. value.
Increment	A stencil function result that increments the current stencil buffer value.
IncrementWrap	A stencil function result that increments the current stencil buffer value and wraps around to the lowest stencil value if it reaches the max.
Invert	A stencil function result that bitwise inverts the current stencil buffer value.
Keep	A stencil function result that keeps the current value.
Replace	A stencil function result that sets the stencil buffer value to ref, as specified by stencil function.
Zero	A stencil function result that sets the stencil buffer value to 0.

Method Summary

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

Keep

public static final StencilState.StencilOperation Keep

A stencil function result that keeps the current value.

Zero

public static final StencilState.StencilOperation Zero

A stencil function result that sets the stencil buffer value to 0.

Replace

public static final StencilState.StencilOperation Replace

A stencil function result that sets the stencil buffer value to ref, as specified by stencil function.

Increment

public static final StencilState.StencilOperation Increment

A stencil function result that increments the current stencil buffer value.

Decrement

public static final StencilState.StencilOperation Decrement

A stencil function result that decrements the current stencil buffer value.

IncrementWrap

public static final StencilState.StencilOperation IncrementWrap

A stencil function result that increments the current stencil buffer value and wraps around to the lowest stencil value if it reaches the max. (if the renderer does not support stencil wrap, we'll fall back to Increment)

DecrementWrap

public static final StencilState.StencilOperation DecrementWrap

A stencil function result that decrements the current stencil buffer and wraps around to the highest stencil value if it reaches the min. value. (if the renderer does not support stencil wrap, we'll fall back to Decrement)

Invert

public static final StencilState.StencilOperation Invert

A stencil function result that bitwise inverts the current stencil buffer value.

Method Details

values

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