org.fujion.canvas.webgl

Enum StencilFunction

java.lang.Object

java.lang.Enum<StencilFunction>

org.fujion.canvas.webgl.StencilFunction

All Implemented Interfaces:

Serializable, Comparable<StencilFunction>, IEnumWithValue, IClientTransform

public enum StencilFunction
extends Enum<StencilFunction>
implements IEnumWithValue

Stencil functions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECR Decrements the current stencil buffer value.
DECR_WRAP Decrements the current stencil buffer value.
INCR Increments the current stencil buffer value.
INCR_WRAP Increments the current stencil buffer value.
INVERT Inverts the current stencil buffer value bitwise.
KEEP Keeps the current value.
REPLACE Sets the stencil buffer value to the reference value as specified by RenderingContextWebGL.stencilFunc(org.fujion.canvas.webgl.DepthFunction, int, int).
ZERO Sets the stencil buffer value to 0.

Method Summary

Modifier and Type	Method and Description
int	value()
static StencilFunction	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

Methods inherited from interface org.fujion.ancillary.IEnumWithValue

fromValue, transformForClient

Enum Constant Detail

DECR

public static final StencilFunction DECR

Decrements the current stencil buffer value. Clamps to 0.

DECR_WRAP

public static final StencilFunction DECR_WRAP

Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of 0.

INCR

public static final StencilFunction INCR

Increments the current stencil buffer value. Clamps to the maximum representable unsigned value.

INCR_WRAP

public static final StencilFunction INCR_WRAP

Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value.

INVERT

public static final StencilFunction INVERT

Inverts the current stencil buffer value bitwise.

KEEP

public static final StencilFunction KEEP

Keeps the current value.

REPLACE

public static final StencilFunction REPLACE

Sets the stencil buffer value to the reference value as specified by RenderingContextWebGL.stencilFunc(org.fujion.canvas.webgl.DepthFunction, int, int).

ZERO

public static final StencilFunction ZERO

Sets the stencil buffer value to 0.

Method Detail

values

public static 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 (StencilFunction c : 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 StencilFunction 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

value

public int value()

Specified by:

value in interface IEnumWithValue