com.jme.scene.state
Enum StencilState.StencilFunction

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

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


Enum Constant Summary
Always
          A stencil function that always passes.
EqualTo
          A stencil function that passes if (ref & max) == (stencil & mask).
GreaterThan
          A stencil function that passes if (ref & max) > (stencil & mask).
GreaterThanOrEqualTo
          A stencil function that passes if (ref & max) >= (stencil & mask).
LessThan
          A stencil function that passes if (ref & mask) < (stencil & mask).
LessThanOrEqualTo
          A stencil function that passes if (ref & max) <= (stencil & mask).
Never
          A stencil function that never passes.
NotEqualTo
          A stencil function that passes if (ref & max) != (stencil & mask).
 
Method Summary
static StencilState.StencilFunction valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static StencilState.StencilFunction[] 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 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 & max) <= (stencil & mask).


GreaterThan

public static final StencilState.StencilFunction GreaterThan
A stencil function that passes if (ref & max) > (stencil & mask).


GreaterThanOrEqualTo

public static final StencilState.StencilFunction GreaterThanOrEqualTo
A stencil function that passes if (ref & max) >= (stencil & mask).


EqualTo

public static final StencilState.StencilFunction EqualTo
A stencil function that passes if (ref & max) == (stencil & mask).


NotEqualTo

public static final StencilState.StencilFunction NotEqualTo
A stencil function that passes if (ref & max) != (stencil & mask).


Always

public static final StencilState.StencilFunction Always
A stencil function that always passes. (Default)

Method Detail

values

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