agi.foundation.graphics.renderer

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

Class TextureFilter2D

java.lang.Object

agi.foundation.graphics.renderer.TextureFilter2D

All Implemented Interfaces:

IEquatable<TextureFilter2D>, ImmutableValueType, ValueType

public final class TextureFilter2D
extends Object
implements IEquatable<TextureFilter2D>, ImmutableValueType

Represents filtering for a texture

Constructor Summary

Constructors

Constructor and Description
TextureFilter2D() Initializes a new instance.
TextureFilter2D(MinificationFilter minificationFilter, MagnificationFilter magnificationFilter) Initializes a texture filter with the specified minificationFilter and magnificationFilter.
TextureFilter2D(MinificationFilter minificationFilter, MagnificationFilter magnificationFilter, TextureWrap wrapS, TextureWrap wrapT) Initializes a texture filter with the specified filters and texture wrap.
TextureFilter2D(TextureWrap wrapS, TextureWrap wrapT) Initializes a texture filter with the specified wrapS and wrapT.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(TextureFilter2D left, TextureFilter2D right) Returns true if the two instances are exactly equal.
boolean	equalsType(TextureFilter2D other) Indicates whether another instance of this type is exactly equal to this instance.
static TextureFilter2D	getLinearClampToEdge() Gets a texture filter with the following properties:
static TextureFilter2D	getLinearRepeat() Gets a texture filter with the following properties:
MagnificationFilter	getMagnificationFilter() Gets the magnification filter used when the pixel being textured maps to an area greater than one texel.
MinificationFilter	getMinificationFilter() Gets the minification filter used when the pixel being textured maps to an area less than or equal to one texel.
static TextureFilter2D	getNearestClampToEdge() Gets a texture filter with the following properties:
static TextureFilter2D	getNearestRepeat() Gets a texture filter with the following properties:
TextureWrap	getWrapS() Gets the texture wrap for the s direction.
TextureWrap	getWrapT() Gets the texture wrap for the t direction.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(TextureFilter2D left, TextureFilter2D right) Returns true if the two instances are not exactly equal.
static boolean	supported(TextureWrap textureWrap) Gets whether or not the video card supports the specified textureWrap.
String	toString() Returns the string representation of the value of this instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextureFilter2D

public TextureFilter2D()

Initializes a new instance.

TextureFilter2D

public TextureFilter2D(@Nonnull
                       MinificationFilter minificationFilter,
                       @Nonnull
                       MagnificationFilter magnificationFilter,
                       @Nonnull
                       TextureWrap wrapS,
                       @Nonnull
                       TextureWrap wrapT)

Initializes a texture filter with the specified filters and texture wrap.

Parameters:

minificationFilter - The minification filter to use when the pixel being textured maps to an area less than or equal to one texel.

magnificationFilter - The magnification filter to use when the pixel being textured maps to an area greater than one texel.

wrapS - The texture wrap for the s direction.

wrapT - The texture wrap for the t direction.

TextureFilter2D

public TextureFilter2D(@Nonnull
                       TextureWrap wrapS,
                       @Nonnull
                       TextureWrap wrapT)

Initializes a texture filter with the specified wrapS and wrapT.

Parameters:

wrapS - The texture wrap for the s direction.

wrapT - The texture wrap for the t direction.

TextureFilter2D

public TextureFilter2D(@Nonnull
                       MinificationFilter minificationFilter,
                       @Nonnull
                       MagnificationFilter magnificationFilter)

Initializes a texture filter with the specified minificationFilter and magnificationFilter.

Parameters:

minificationFilter - The minification filter to use when the pixel being textured maps to an area less than or equal to one texel.

magnificationFilter - The magnification filter to use when the pixel being textured maps to an area greater than one texel.

Method Detail

getMinificationFilter

@Nonnull
public final MinificationFilter getMinificationFilter()

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

getMagnificationFilter

@Nonnull
public final MagnificationFilter getMagnificationFilter()

Gets the magnification filter used when the pixel being textured maps to an area greater than one texel.

getWrapS

@Nonnull
public final TextureWrap getWrapS()

Gets the texture wrap for the s direction.

getWrapT

@Nonnull
public final TextureWrap getWrapT()

Gets the texture wrap for the t direction.

getNearestClampToEdge

@Nonnull
public static TextureFilter2D getNearestClampToEdge()

Gets a texture filter with the following properties:

Property	Value
MinificationFilter (get)	Nearest
MagnificationFilter (get)	Nearest
WrapS (get)	ClampToEdge
WrapT (get)	ClampToEdge

getNearestRepeat

@Nonnull
public static TextureFilter2D getNearestRepeat()

Gets a texture filter with the following properties:

Property	Value
MinificationFilter (get)	Nearest
MagnificationFilter (get)	Nearest
WrapS (get)	Repeat
WrapT (get)	Repeat

getLinearClampToEdge

@Nonnull
public static TextureFilter2D getLinearClampToEdge()

Gets a texture filter with the following properties:

Property	Value
MinificationFilter (get)	Linear
MagnificationFilter (get)	Linear
WrapS (get)	ClampToEdge
WrapT (get)	ClampToEdge

getLinearRepeat

@Nonnull
public static TextureFilter2D getLinearRepeat()

Gets a texture filter with the following properties:

Property	Value
MinificationFilter (get)	Linear
MagnificationFilter (get)	Linear
WrapS (get)	Repeat
WrapT (get)	Repeat

supported

public static boolean supported(@Nonnull
                                TextureWrap textureWrap)

Gets whether or not the video card supports the specified textureWrap.

Parameters:

textureWrap - The texture wrap to check support for.

Returns:

true if the video card supports textureWrap; otherwise false.

Throws:

UnsupportedCaseException - textureWrap must be a valid enumeration value in TextureWrap.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(@Nonnull
                                TextureFilter2D other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<TextureFilter2D>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Returns the string representation of the value of this instance.

Overrides:

toString in class Object

Returns:

A string that represents the value of this instance in the form MinificationFilter, MagnificationFilter, WrapS, WrapT.

equals

public static boolean equals(@Nonnull
                             TextureFilter2D left,
                             @Nonnull
                             TextureFilter2D right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                TextureFilter2D left,
                                @Nonnull
                                TextureFilter2D right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.