agi.foundation.graphics.renderer

(agi.foundation.graphics-2024r2.jar)

Enum CullFace

java.lang.Object

java.lang.Enum<CullFace>

agi.foundation.graphics.renderer.CullFace

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CullFace>

public enum CullFace
extends Enum<CullFace>
implements Enumeration

Identifies whether front- and/or back-facing triangles are culled.

See Also:

Backface Culling topic

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK Back-facing triangles are culled.
FRONT Front-facing triangles are culled.
FRONT_AND_BACK Both front- and back-facing triangles are culled.
NEITHER No triangles are culled.

Method Summary

Modifier and Type	Method and Description
static CullFace	getDefault() Get the enum constant that is considered to be the default.
static CullFace	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static CullFace	valueOf(String name) Returns the enum constant of this type with the specified name.
static CullFace[]	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

FRONT

public static final CullFace FRONT

Front-facing triangles are culled.

BACK

public static final CullFace BACK

Back-facing triangles are culled.

FRONT_AND_BACK

public static final CullFace FRONT_AND_BACK

Both front- and back-facing triangles are culled. Therefore, no triangles are rendered.

NEITHER

public static final CullFace NEITHER

No triangles are culled.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static CullFace getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static CullFace getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.