agi.foundation.graphics.renderer

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

Enum MagnificationFilter

java.lang.Object

java.lang.Enum<MagnificationFilter>

agi.foundation.graphics.renderer.MagnificationFilter

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MagnificationFilter>

public enum MagnificationFilter
extends Enum<MagnificationFilter>
implements Enumeration

The filter used when the pixel being textured maps to an area less than or equal to one texel.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LINEAR Use the weighted average of the four texels that are closest to the center of the pixel being textured.
NEAREST Use the texel that is closest to the center of the pixel being textured.

Method Summary

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

NEAREST

public static final MagnificationFilter NEAREST

Use the texel that is closest to the center of the pixel being textured. This usually faster than Linear but can produce images with sharper edges.

LINEAR

public static final MagnificationFilter LINEAR

Use the weighted average of the four texels that are closest to the center of the pixel being textured.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.