agi.foundation.graphics.advanced

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

Enum RenderPassHint

java.lang.Object

java.lang.Enum<RenderPassHint>

agi.foundation.graphics.advanced.RenderPassHint

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RenderPassHint>

public enum RenderPassHint
extends Enum<RenderPassHint>
implements Enumeration

An optimization hint optionally provided to a primitive's Set method to enhance performance when per-position colors are used.

See Also:

Point Batch Primitive topic, Polyline Primitive topic

Enum Constant Summary

Enum Constants

Enum Constant and Description
OPAQUE The collection of Colors contains only opaque colors.
TRANSLUCENT The collection of Colors contains translucent colors.
UNKNOWN It is unknown if the collection of Colors contains opaque or translucent colors.

Method Summary

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

OPAQUE

public static final RenderPassHint OPAQUE

The collection of Colors contains only opaque colors. This implies that each color's alpha component is 255.

TRANSLUCENT

public static final RenderPassHint TRANSLUCENT

The collection of Colors contains translucent colors. This implies that at least one color has an alpha component that is not 255.

UNKNOWN

public static final RenderPassHint UNKNOWN

It is unknown if the collection of Colors contains opaque or translucent colors.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.