agi.foundation.graphics.advanced

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

Enum MarkerBatchRenderingMethod

java.lang.Object

java.lang.Enum<MarkerBatchRenderingMethod>

agi.foundation.graphics.advanced.MarkerBatchRenderingMethod

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MarkerBatchRenderingMethod>

public enum MarkerBatchRenderingMethod
extends Enum<MarkerBatchRenderingMethod>
implements Enumeration

Rendering methods available for use by the marker batch primitive. Different methods may have different performance characteristics and require different video card support. When in doubt, use Automatic.

See Also:

System Requirements topic, Marker Batch Primitive topic, MarkerBatchPrimitive

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC Render the marker batch using an automatically selected method based on the capabilities of the video card.
FIXED_FUNCTION Render the marker batch using the fixed function pipeline.
GEOMETRY_SHADER Render the marker batch using a geometry shader.
VERTEX_SHADER Render the marker batch using a vertex shader.

Method Summary

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

GEOMETRY_SHADER

public static final MarkerBatchRenderingMethod GEOMETRY_SHADER

Render the marker batch using a geometry shader. Requires OpenGL 3.0 or 2.0 with the ARB_geometry_shader4 extension.

VERTEX_SHADER

public static final MarkerBatchRenderingMethod VERTEX_SHADER

Render the marker batch using a vertex shader. Requires OpenGL 2.0 or 1.5 with the following extensions:

GL_ARB_vertex_shader GL_ARB_fragment_shader

AUTOMATIC

public static final MarkerBatchRenderingMethod AUTOMATIC

Render the marker batch using an automatically selected method based on the capabilities of the video card.

FIXED_FUNCTION

public static final MarkerBatchRenderingMethod FIXED_FUNCTION

Render the marker batch using the fixed function pipeline. Generally, this is the slowest method but it supports all video cards.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.