filament-utils/io.github.erkko68.filament.utils/Ktx1Bundle

Ktx1Bundle

class Ktx1Bundle(nativeHandle: NativePointer) : AutoCloseable

An in-memory representation of a KTX1 file: a hierarchy of blobs (miplevels, array elements, cubemap faces) and metadata.

Constructors

Ktx1Bundle

constructor(nativeHandle: NativePointer)

constructor(numMipLevels: Int, arrayLength: Int, isCubemap: Boolean)

Creates a hierarchy of empty texture blobs, to be filled before serializing.

constructor(bytes: ByteArray)

Creates a hierarchy of blobs by parsing the contents of a KTX file; bytes are copied.

Properties

arrayLength

val arrayLength: Int

The number of array elements, which is 1 for a plain texture.

isCubemap

val isCubemap: Boolean

Whether the bundle holds a cubemap (6 faces per miplevel and array element).

nativeObject

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

numMipLevels

val numMipLevels: Int

The number of miplevels.

serializedLength

val serializedLength: Int

The size of the KTX file serialize writes.

Functions

open override fun close()

Same as destroy; lets this be used with use { } and try-with-resources.

destroy

fun destroy()

Frees the bundle, unless Ktx1Reader.createTexture took it.

getMetadata

fun getMetadata(key: String): String?

The KTX metadata value of key, or null if it has none.

getSphericalHarmonics

fun getSphericalHarmonics(result: FloatArray): Boolean

Parses the key="sh" metadata into result: 3 bands of spherical harmonics, 9 RGB coefficients (27 floats).

serialize

fun serialize(destination: ByteArray): Boolean

Writes out the KTX file into destination, which must hold serializedLength bytes; false if it's too small.

setMetadata

fun setMetadata(key: String, value: String)

Adds a key/value pair to the KTX metadata.

Ktx1Bundle

See also

Constructors

Properties

Functions