Package com.io7m.calino.api
Record Class CLNImageCubeDescription
java.lang.Object
java.lang.Record
com.io7m.calino.api.CLNImageCubeDescription
- Record Components:
mipMapLevel
- The mipmap levelface
- The cube facedataSizeCompressed
- The size of the compressed datadataOffsetWithinSection
- The offset within the sectioncrc32Uncompressed
- The CRC32 of the uncompressed datadataSizeUncompressed
- The size of the uncompressed data
- All Implemented Interfaces:
CLNImageDescriptionType
,Comparable<CLNImageCubeDescription>
public record CLNImageCubeDescription(int mipMapLevel, CLNCubeFace face, long dataOffsetWithinSection, long dataSizeUncompressed, long dataSizeCompressed, int crc32Uncompressed)
extends Record
implements CLNImageDescriptionType, Comparable<CLNImageCubeDescription>
A description of a single cube face image.
-
Constructor Summary
ConstructorDescriptionCLNImageCubeDescription
(int mipMapLevel, CLNCubeFace face, long dataOffsetWithinSection, long dataSizeUncompressed, long dataSizeCompressed, int crc32Uncompressed) A description of a single cube face image. -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(CLNImageCubeDescription other) int
Returns the value of thecrc32Uncompressed
record component.long
Returns the value of thedataOffsetWithinSection
record component.long
Returns the value of thedataSizeCompressed
record component.long
Returns the value of thedataSizeUncompressed
record component.final boolean
Indicates whether some other object is "equal to" this one.face()
Returns the value of theface
record component.final int
hashCode()
Returns a hash code value for this object.int
Returns the value of themipMapLevel
record component.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
CLNImageCubeDescription
public CLNImageCubeDescription(int mipMapLevel, CLNCubeFace face, long dataOffsetWithinSection, long dataSizeUncompressed, long dataSizeCompressed, int crc32Uncompressed) A description of a single cube face image.- Parameters:
mipMapLevel
- The mipmap levelface
- The cube facedataSizeCompressed
- The size of the compressed datadataOffsetWithinSection
- The offset within the sectioncrc32Uncompressed
- The CRC32 of the uncompressed datadataSizeUncompressed
- The size of the uncompressed data
-
-
Method Details
-
compareTo
- Specified by:
compareTo
in interfaceComparable<CLNImageCubeDescription>
-
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. -
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. -
equals
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. Reference components are compared withObjects::equals(Object,Object)
; primitive components are compared with '=='. -
mipMapLevel
public int mipMapLevel()Returns the value of themipMapLevel
record component.- Specified by:
mipMapLevel
in interfaceCLNImageDescriptionType
- Returns:
- the value of the
mipMapLevel
record component
-
face
Returns the value of theface
record component.- Returns:
- the value of the
face
record component
-
dataOffsetWithinSection
public long dataOffsetWithinSection()Returns the value of thedataOffsetWithinSection
record component.- Specified by:
dataOffsetWithinSection
in interfaceCLNImageDescriptionType
- Returns:
- the value of the
dataOffsetWithinSection
record component
-
dataSizeUncompressed
public long dataSizeUncompressed()Returns the value of thedataSizeUncompressed
record component.- Specified by:
dataSizeUncompressed
in interfaceCLNImageDescriptionType
- Returns:
- the value of the
dataSizeUncompressed
record component
-
dataSizeCompressed
public long dataSizeCompressed()Returns the value of thedataSizeCompressed
record component.- Specified by:
dataSizeCompressed
in interfaceCLNImageDescriptionType
- Returns:
- the value of the
dataSizeCompressed
record component
-
crc32Uncompressed
public int crc32Uncompressed()Returns the value of thecrc32Uncompressed
record component.- Specified by:
crc32Uncompressed
in interfaceCLNImageDescriptionType
- Returns:
- the value of the
crc32Uncompressed
record component
-