com.neovisionaries.android.opengl
Enum StencilComparisonOperator

java.lang.Object
  extended by java.lang.Enum<StencilComparisonOperator>
      extended by com.neovisionaries.android.opengl.StencilComparisonOperator
All Implemented Interfaces:
Serializable, Comparable<StencilComparisonOperator>

public enum StencilComparisonOperator
extends Enum<StencilComparisonOperator>

Comparison operator used for the stencil test.

Author:
Takahiko Kawasaki
See Also:
StencilComparator, glStencilFunc, glStencilFuncSeparate

Enum Constant Summary
ALWAYS
          GL_ALWAYS.
EQUAL
          GL_EQUAL.
GEQUAL
          GL_GEQUAL.
GREATER
          GL_GREATER.
LEQUAL
          GL_LEQUAL.
LESS
          GL_LESS.
NEVER
          GL_NEVER.
NOTEQUAL
          GL_NOTEQUAL.
 
Method Summary
 int getOperator()
          Get the integer representing this comparison operator.
static StencilComparisonOperator valueOf(String name)
          Returns the enum constant of this type with the specified name.
static StencilComparisonOperator[] 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

EQUAL

public static final StencilComparisonOperator EQUAL
GL_EQUAL.


NOTEQUAL

public static final StencilComparisonOperator NOTEQUAL
GL_NOTEQUAL.


LESS

public static final StencilComparisonOperator LESS
GL_LESS.


GREATER

public static final StencilComparisonOperator GREATER
GL_GREATER.


LEQUAL

public static final StencilComparisonOperator LEQUAL
GL_LEQUAL.


GEQUAL

public static final StencilComparisonOperator GEQUAL
GL_GEQUAL.


ALWAYS

public static final StencilComparisonOperator ALWAYS
GL_ALWAYS.


NEVER

public static final StencilComparisonOperator NEVER
GL_NEVER.

Method Detail

values

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

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

valueOf

public static StencilComparisonOperator valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getOperator

public int getOperator()
Get the integer representing this comparison operator.

Returns:
The integer representing this comparison operator.