org.fujion.canvas.webgl

Enum DepthFunction

java.lang.Object

java.lang.Enum<DepthFunction>

org.fujion.canvas.webgl.DepthFunction

All Implemented Interfaces:

Serializable, Comparable<DepthFunction>, IEnumWithValue, IClientTransform

public enum DepthFunction
extends Enum<DepthFunction>
implements IEnumWithValue

Functions that compare incoming pixel depth to the current depth buffer value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always pass.
EQUAL Pass if the incoming value equals the the depth buffer value.
GEQUAL Pass if the incoming value is greater than or equal to the depth buffer value.
GREATER Pass if the incoming value is greater than the depth buffer value.
LEQUAL Pass if the incoming value is less than or equal to the depth buffer value.
LESS Pass if the incoming value is less than the depth buffer value.
NEVER Never pass.
NOTEQUAL Pass if the incoming value is not equal to the depth buffer value.

Method Summary

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

ALWAYS

public static final DepthFunction ALWAYS

Always pass.

EQUAL

public static final DepthFunction EQUAL

Pass if the incoming value equals the the depth buffer value.

GEQUAL

public static final DepthFunction GEQUAL

Pass if the incoming value is greater than or equal to the depth buffer value.

GREATER

public static final DepthFunction GREATER

Pass if the incoming value is greater than the depth buffer value.

LEQUAL

public static final DepthFunction LEQUAL

Pass if the incoming value is less than or equal to the depth buffer value.

LESS

public static final DepthFunction LESS

Pass if the incoming value is less than the depth buffer value.

NEVER

public static final DepthFunction NEVER

Never pass.

NOTEQUAL

public static final DepthFunction NOTEQUAL

Pass if the incoming value is not equal to the depth buffer value.

Method Detail

values

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

Returns:

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

valueOf

public static DepthFunction 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