agi.foundation.graphics.advanced

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

Enum MarkerBatchRenderPass

java.lang.Object

java.lang.Enum<MarkerBatchRenderPass>

agi.foundation.graphics.advanced.MarkerBatchRenderPass

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MarkerBatchRenderPass>

public enum MarkerBatchRenderPass
extends Enum<MarkerBatchRenderPass>
implements Enumeration

The pass during which the marker batch is rendered.

See Also:

RenderPass

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASED_ON_TRANSLUCENCY The marker batch render pass should be determined based on the marker batch's translucency.
OPAQUE The marker batch contains all opaque textures and therefore should be rendered using the Opaque pass.
TRANSLUCENT The marker batch contains textures with translucency and therefore should be rendered using the Translucent pass.

Method Summary

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

The marker batch contains all opaque textures and therefore should be rendered using the Opaque pass.

TRANSLUCENT

public static final MarkerBatchRenderPass TRANSLUCENT

The marker batch contains textures with translucency and therefore should be rendered using the Translucent pass. For correct blending of overlapping textures, also consider using MarkerBatchSortOrder.BackToFront.

BASED_ON_TRANSLUCENCY

public static final MarkerBatchRenderPass BASED_ON_TRANSLUCENCY

The marker batch render pass should be determined based on the marker batch's translucency. This includes the translucency set per marker when MarkerBatchPrimitiveOptionalParameters.SetColors is used.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.