agi.foundation.graphics.advanced

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

Enum PrimitivesSortOrder

java.lang.Object

java.lang.Enum<PrimitivesSortOrder>

agi.foundation.graphics.advanced.PrimitivesSortOrder

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PrimitivesSortOrder>

public enum PrimitivesSortOrder
extends Enum<PrimitivesSortOrder>
implements Enumeration

The order in which primitives are sorted before rendering.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK_TO_FRONT Primitives are sorted in back to front order before rendering.
BY_STATE Primitives are sorted by their internal state before rendering.

Method Summary

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

BY_STATE

public static final PrimitivesSortOrder BY_STATE

Primitives are sorted by their internal state before rendering. This provides good performance but can lead to blending artifacts with translucent primitives along the same line of sight.

BACK_TO_FRONT

public static final PrimitivesSortOrder BACK_TO_FRONT

Primitives are sorted in back to front order before rendering. For translucent primitives, this enables correct blending results. This may not perform as well as PrimitivesSortOrderByState since the CPU has to sort the primitives before rendering.

Method Detail

values

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

Returns:

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

valueOf

public static PrimitivesSortOrder 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 PrimitivesSortOrder 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 PrimitivesSortOrder getDefault()

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

Returns:

The default enum constant.