Package com.io7m.calino.api
Record Class CLNImageInfo
java.lang.Object
java.lang.Record
com.io7m.calino.api.CLNImageInfo
- Record Components:
sizeX
- The size, in pixels, of the image data on the X axissizeY
- The size, in pixels, of the image data on the Y axissizeZ
- The size, in pixels, of the image data on the Z axischannelsLayout
- The layout of the channels in the image datachannelsType
- The type of the channels in the image datacompressionMethod
- The compression method used for the image datasuperCompressionMethod
- The supercompression method used to encapsulate image datacoordinateSystem
- The coordinate system orientationcolorSpace
- The image color spaceflags
- The image flagsdataByteOrder
- The byte order of image data
public record CLNImageInfo(int sizeX, int sizeY, int sizeZ, CLNChannelsLayoutDescriptionType channelsLayout, CLNChannelsTypeDescriptionType channelsType, CLNCompressionMethodType compressionMethod, CLNSuperCompressionMethodType superCompressionMethod, CLNCoordinateSystem coordinateSystem, CLNColorSpaceType colorSpace, Set<CLNImageFlagType> flags, CLNByteOrder dataByteOrder)
extends Record
Information about an image.
This describes the size and format of image data included in a texture file.
-
Constructor Summary
ConstructorDescriptionCLNImageInfo
(int sizeX, int sizeY, int sizeZ, CLNChannelsLayoutDescriptionType channelsLayout, CLNChannelsTypeDescriptionType channelsType, CLNCompressionMethodType compressionMethod, CLNSuperCompressionMethodType superCompressionMethod, CLNCoordinateSystem coordinateSystem, CLNColorSpaceType colorSpace, Set<CLNImageFlagType> flags, CLNByteOrder dataByteOrder) Information about an image. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thechannelsLayout
record component.Returns the value of thechannelsType
record component.Returns the value of thecolorSpace
record component.Returns the value of thecompressionMethod
record component.Returns the value of thecoordinateSystem
record component.Returns the value of thedataByteOrder
record component.final boolean
Indicates whether some other object is "equal to" this one.flags()
Returns the value of theflags
record component.final int
hashCode()
Returns a hash code value for this object.showSize()
int
sizeX()
Returns the value of thesizeX
record component.int
sizeY()
Returns the value of thesizeY
record component.int
sizeZ()
Returns the value of thesizeZ
record component.Returns the value of thesuperCompressionMethod
record component.int
final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
CLNImageInfo
public CLNImageInfo(int sizeX, int sizeY, int sizeZ, CLNChannelsLayoutDescriptionType channelsLayout, CLNChannelsTypeDescriptionType channelsType, CLNCompressionMethodType compressionMethod, CLNSuperCompressionMethodType superCompressionMethod, CLNCoordinateSystem coordinateSystem, CLNColorSpaceType colorSpace, Set<CLNImageFlagType> flags, CLNByteOrder dataByteOrder) Information about an image. This describes the size and format of image data included in a texture file.- Parameters:
sizeX
- The size, in pixels, of the image data on the X axissizeY
- The size, in pixels, of the image data on the Y axissizeZ
- The size, in pixels, of the image data on the Z axischannelsLayout
- The layout of the channels in the image datachannelsType
- The type of the channels in the image datacompressionMethod
- The compression method used for the image datasuperCompressionMethod
- The supercompression method used to encapsulate image datacoordinateSystem
- The coordinate system orientationcolorSpace
- The image color spaceflags
- The image flagsdataByteOrder
- The byte order of image data
-
-
Method Details
-
texelBlockAlignment
public int texelBlockAlignment()- Returns:
- The required alignment of texel data
-
showSize
- Returns:
- A humanly-readable description of the image size
-
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 '=='. -
sizeX
public int sizeX()Returns the value of thesizeX
record component.- Returns:
- the value of the
sizeX
record component
-
sizeY
public int sizeY()Returns the value of thesizeY
record component.- Returns:
- the value of the
sizeY
record component
-
sizeZ
public int sizeZ()Returns the value of thesizeZ
record component.- Returns:
- the value of the
sizeZ
record component
-
channelsLayout
Returns the value of thechannelsLayout
record component.- Returns:
- the value of the
channelsLayout
record component
-
channelsType
Returns the value of thechannelsType
record component.- Returns:
- the value of the
channelsType
record component
-
compressionMethod
Returns the value of thecompressionMethod
record component.- Returns:
- the value of the
compressionMethod
record component
-
superCompressionMethod
Returns the value of thesuperCompressionMethod
record component.- Returns:
- the value of the
superCompressionMethod
record component
-
coordinateSystem
Returns the value of thecoordinateSystem
record component.- Returns:
- the value of the
coordinateSystem
record component
-
colorSpace
Returns the value of thecolorSpace
record component.- Returns:
- the value of the
colorSpace
record component
-
flags
Returns the value of theflags
record component.- Returns:
- the value of the
flags
record component
-
dataByteOrder
Returns the value of thedataByteOrder
record component.- Returns:
- the value of the
dataByteOrder
record component
-