Class CLN2SectionReadableImageCube

java.lang.Object

com.io7m.calino.vanilla.internal.CLN2SectionReadableAbstract

com.io7m.calino.vanilla.internal.CLN2SectionReadableImageCube

All Implemented Interfaces:

CLNSectionReadableImageCubeType, CLNSectionReadableStandardType, CLNSectionReadableType, AutoCloseable

public final class CLN2SectionReadableImageCube
extends CLN2SectionReadableAbstract
implements CLNSectionReadableImageCubeType

A readable cube image section.

Method Summary

Modifier and Type	Method	Description
SeekableByteChannel	mipMapDataRaw(CLNImageCubeDescription description)	Obtain a readable channel that returns potentially compressed data.
ReadableByteChannel	mipMapDataWithoutSupercompression(CLNImageCubeDescription description)	Obtain a readable channel that returns decompressed data (that is, data with any supercompression removed).
List<CLNImageCubeDescription>	mipMapDescriptions()

Methods inherited from class CLN2SectionReadableAbstract

close, errorLimitExceeded, reader, request, section, sectionDataChannel, sectionDataReader

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CLNSectionReadableType

close, section, sectionDataChannel

Method Details

mipMapDescriptions

public List<CLNImageCubeDescription> mipMapDescriptions()
                                                 throws CLNException

Specified by:

mipMapDescriptions in interface CLNSectionReadableImageCubeType

Returns:

The set of declared mipmaps

Throws:

CLNException - On errors

mipMapDataWithoutSupercompression

public ReadableByteChannel mipMapDataWithoutSupercompression(CLNImageCubeDescription description)
                                                      throws CLNException

Description copied from interface: CLNSectionReadableImageCubeType

Obtain a readable channel that returns decompressed data (that is, data with any supercompression removed).

Specified by:

mipMapDataWithoutSupercompression in interface CLNSectionReadableImageCubeType

Parameters:

description - The image description

Returns:

A readable channel

Throws:

CLNException - On I/O errors

mipMapDataRaw

public SeekableByteChannel mipMapDataRaw(CLNImageCubeDescription description)
                                  throws CLNException

Description copied from interface: CLNSectionReadableImageCubeType

Obtain a readable channel that returns potentially compressed data. The bytes returned by the channel are not interpreted in any form, and are exactly as they appeared in the underlying file.

Specified by:

mipMapDataRaw in interface CLNSectionReadableImageCubeType

Parameters:

description - The image description

Returns:

A readable channel

Throws:

CLNException - On I/O errors