agi.foundation.graphics.renderer

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

Class TextureTemplate2D

java.lang.Object

agi.foundation.graphics.renderer.TextureTemplate2D

All Implemented Interfaces:

IEquatable<TextureTemplate2D>, ImmutableValueType, ValueType

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

Template object containing attributes required to create a 2D texture.

Constructor Summary

Constructors

Constructor and Description
TextureTemplate2D() Initializes a new instance.
TextureTemplate2D(InternalTextureFormat internalFormat, int width, int height) Initializes a 2D texture template with no mipmapping.

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(TextureTemplate2D left, TextureTemplate2D right) Returns true if the two instances are exactly equal.
boolean	equalsType(TextureTemplate2D other) Indicates whether another instance of this type is exactly equal to this instance.
int	getHeight() Gets the height of the texture in texels.
InternalTextureFormat	getInternalFormat() Gets the internal format of the texture.
int	getWidth() Gets the width of the texture in texels.
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(TextureTemplate2D left, TextureTemplate2D right) Returns true if the two instances are not exactly equal.
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

TextureTemplate2D

public TextureTemplate2D()

Initializes a new instance.

TextureTemplate2D

public TextureTemplate2D(@Nonnull
                         InternalTextureFormat internalFormat,
                         int width,
                         int height)

Initializes a 2D texture template with no mipmapping.

Parameters:

internalFormat - The InternalFormat (get) of the texture.

width - The width of the texture in texels.

height - The height of the texture in texels.

Method Detail

getInternalFormat

@Nonnull
public final InternalTextureFormat getInternalFormat()

Gets the internal format of the texture.

getWidth

public final int getWidth()

Gets the width of the texture in texels.

getHeight

public final int getHeight()

Gets the height of the texture in texels.

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
                                TextureTemplate2D other)

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

Specified by:

equalsType in interface IEquatable<TextureTemplate2D>

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 InternalFormat, Width, Height.

equals

public static boolean equals(@Nonnull
                             TextureTemplate2D left,
                             @Nonnull
                             TextureTemplate2D 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
                                TextureTemplate2D left,
                                @Nonnull
                                TextureTemplate2D 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.