agi.foundation.graphics.renderer

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

Enum TextureWrap

java.lang.Object

java.lang.Enum<TextureWrap>

agi.foundation.graphics.renderer.TextureWrap

All Implemented Interfaces:

Enumeration, Serializable, Comparable<TextureWrap>

public enum TextureWrap
extends Enum<TextureWrap>
implements Enumeration

Determine how to handle textures coordinates that fall outside of the range [0, 1].

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLAMP Clamp the texture coordinate to the range [0, 1].
CLAMP_TO_BORDER Clamp the texture coordinate to the range [-1/2N, 1 + 1/2N], where N is the size the texture in the direction of clamping.
CLAMP_TO_EDGE Clamp the texture coordinate to the range [1/2N, 1 - 1/2N], where N is the size the texture in the direction of clamping.
MIRRORED_REPEAT If the integer part of the texture coordinate is even, use the fractional part of the texture coordinate.
REPEAT Ignore the integer part of the texture coordinate.

Method Summary

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

CLAMP

public static final TextureWrap CLAMP

Clamp the texture coordinate to the range [0, 1].

CLAMP_TO_BORDER

public static final TextureWrap CLAMP_TO_BORDER

Clamp the texture coordinate to the range [-1/2N, 1 + 1/2N], where N is the size the texture in the direction of clamping.

CLAMP_TO_EDGE

public static final TextureWrap CLAMP_TO_EDGE

Clamp the texture coordinate to the range [1/2N, 1 - 1/2N], where N is the size the texture in the direction of clamping.

MIRRORED_REPEAT

public static final TextureWrap MIRRORED_REPEAT

If the integer part of the texture coordinate is even, use the fractional part of the texture coordinate. Otherwise, use one minus the fractional part of the texture coordinate.

REPEAT

public static final TextureWrap REPEAT

Ignore the integer part of the texture coordinate.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.