Package com.io7m.calino.api

Record Class CLNImage2DMipMapDeclaration

java.lang.Object

java.lang.Record

com.io7m.calino.api.CLNImage2DMipMapDeclaration

Record Components:

mipMapLevel - The mipmap level

sizeCompressed - The size of the supercompressed data in octets

sizeUncompressed - The size of the uncompressed data in octets

crc32 - The CRC32 checksum of the uncompressed data

All Implemented Interfaces:

Comparable<CLNImage2DMipMapDeclaration>

public record CLNImage2DMipMapDeclaration(int mipMapLevel, long sizeCompressed, long sizeUncompressed, int crc32)
extends Record
implements Comparable<CLNImage2DMipMapDeclaration>

The declaration of a single mipmap.

Constructor Summary

Constructors

Constructor	Description
CLNImage2DMipMapDeclaration(int mipMapLevel, long sizeCompressed, long sizeUncompressed, int crc32)	Creates an instance of a CLNImage2DMipMapDeclaration record class.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CLNImage2DMipMapDeclaration other)
int	crc32()	Returns the value of the crc32 record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	mipMapLevel()	Returns the value of the mipMapLevel record component.
long	sizeCompressed()	Returns the value of the sizeCompressed record component.
long	sizeUncompressed()	Returns the value of the sizeUncompressed record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

CLNImage2DMipMapDeclaration

public CLNImage2DMipMapDeclaration(int mipMapLevel,
 long sizeCompressed,
 long sizeUncompressed,
 int crc32)

Creates an instance of a CLNImage2DMipMapDeclaration record class.

Parameters:

mipMapLevel - the value for the mipMapLevel record component

sizeCompressed - the value for the sizeCompressed record component

sizeUncompressed - the value for the sizeUncompressed record component

crc32 - the value for the crc32 record component

Method Details

compareTo

public int compareTo(CLNImage2DMipMapDeclaration other)

Specified by:

compareTo in interface Comparable<CLNImage2DMipMapDeclaration>

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

mipMapLevel

public int mipMapLevel()

Returns the value of the mipMapLevel record component.

Returns:

the value of the mipMapLevel record component

sizeCompressed

public long sizeCompressed()

Returns the value of the sizeCompressed record component.

Returns:

the value of the sizeCompressed record component

sizeUncompressed

public long sizeUncompressed()

Returns the value of the sizeUncompressed record component.

Returns:

the value of the sizeUncompressed record component

crc32

public int crc32()

Returns the value of the crc32 record component.

Returns:

the value of the crc32 record component