agi.foundation.graphics.advanced

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

Enum IndicesOrderHint

java.lang.Object

java.lang.Enum<IndicesOrderHint>

agi.foundation.graphics.advanced.IndicesOrderHint

All Implemented Interfaces:

Enumeration, Serializable, Comparable<IndicesOrderHint>

public enum IndicesOrderHint
extends Enum<IndicesOrderHint>
implements Enumeration

An optimization hint optionally provided to a primitive's SetPartial method to enhance performance.

See Also:

Set Hint Performance topic

Enum Constant Summary

Enum Constants

Enum Constant and Description
NOT_SORTED The indices passed to SetPartial are not sorted.
SORTED_ASCENDING The indices passed to SetPartial are sorted in ascending order.

Method Summary

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

NOT_SORTED

public static final IndicesOrderHint NOT_SORTED

The indices passed to SetPartial are not sorted. Therefore, the primitive may sort them to improve performance of writing its geometry to video memory.

SORTED_ASCENDING

public static final IndicesOrderHint SORTED_ASCENDING

The indices passed to SetPartial are sorted in ascending order. Therefore, the primitive does not need to sort them. It is recommended to only use SortedAscending if it is easy and efficient for you to provide the indices in ascending order. For example, do not use a standard sorting algorithm to sort your indices so you can use SortedAscending. Instead, use NotSorted and let the primitive decide what is most efficient.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.