agi.foundation.graphics.advanced

(agi.foundation.graphics-2023r1.jar)

Enum ProjectedRasterRenderPass

java.lang.Object

java.lang.Enum<ProjectedRasterRenderPass>

agi.foundation.graphics.advanced.ProjectedRasterRenderPass

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ProjectedRasterRenderPass>

public enum ProjectedRasterRenderPass
extends Enum<ProjectedRasterRenderPass>
implements Enumeration

The pass during which the projected raster is rendered.

See Also:

RenderPass

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTRAL_BODY_CLIPPED The projected raster should be rendered during the central body clipping pass.
TRANSLUCENT The projected raster should be rendered during the translucent pass.

Method Summary

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

TRANSLUCENT

public static final ProjectedRasterRenderPass TRANSLUCENT

The projected raster should be rendered during the translucent pass.

CENTRAL_BODY_CLIPPED

public static final ProjectedRasterRenderPass CENTRAL_BODY_CLIPPED

The projected raster should be rendered during the central body clipping pass.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.