com.jme.scene.state
Enum StencilState.StencilOperation

java.lang.Object
  extended by java.lang.Enum<StencilState.StencilOperation>
      extended by com.jme.scene.state.StencilState.StencilOperation
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StencilState.StencilOperation>
Enclosing class:
StencilState

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


Enum Constant Summary
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.
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
static StencilState.StencilOperation valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static StencilState.StencilOperation[] 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

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 Detail

values

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

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

valueOf

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