Package com.jme3.material

Enum Class RenderState.StencilOperation

java.lang.Object

java.lang.Enum<RenderState.StencilOperation>

com.jme3.material.RenderState.StencilOperation

All Implemented Interfaces:

Serializable, Comparable<RenderState.StencilOperation>, Constable

Enclosing class:

RenderState

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

StencilOperation specifies the stencil operation to use in a certain scenario as specified in RenderState.setStencil(boolean, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.StencilOperation, com.jme3.material.RenderState.TestFunction, com.jme3.material.RenderState.TestFunction)

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	Decrement the value in the stencil buffer and clamp once reaching 0.
DecrementWrap	Decrement the value in the stencil buffer and wrap to the maximum value when reaching 0.
Increment	Increment the value in the stencil buffer, clamp once reaching the maximum value.
IncrementWrap	Increment the value in the stencil buffer and wrap to 0 when reaching the maximum value.
Invert	Does a bitwise invert of the value in the stencil buffer.
Keep	Keep the current value.
Replace	Replace the value in the stencil buffer with the reference value.
Zero	Set the value to 0

Method Summary

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

Keep the current value.

Zero

public static final RenderState.StencilOperation Zero

Set the value to 0

Replace

public static final RenderState.StencilOperation Replace

Replace the value in the stencil buffer with the reference value.

Increment

public static final RenderState.StencilOperation Increment

Increment the value in the stencil buffer, clamp once reaching the maximum value.

IncrementWrap

public static final RenderState.StencilOperation IncrementWrap

Increment the value in the stencil buffer and wrap to 0 when reaching the maximum value.

Decrement

public static final RenderState.StencilOperation Decrement

Decrement the value in the stencil buffer and clamp once reaching 0.

DecrementWrap

public static final RenderState.StencilOperation DecrementWrap

Decrement the value in the stencil buffer and wrap to the maximum value when reaching 0.

Invert

public static final RenderState.StencilOperation Invert

Does a bitwise invert of the value in the stencil buffer.

Method Details

values

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