@tmrw-realityos/charm

---

@tmrw-realityos/charm / KTX2TextureLoader

Class: KTX2TextureLoader

Defined in: packages/charm/src/helpers/KTX2Loader.ts:27

Loader class for the KTX2 file format. https://registry.khronos.org/KTX/specs/2.0/ktxspec.v2.html

Constructors

Constructor

new KTX2TextureLoader(supportedCompression?): KTX2TextureLoader

Defined in: packages/charm/src/helpers/KTX2Loader.ts:35

Parameters

supportedCompression?

CompressionFeatureName

Transcode compression target format.

Returns

KTX2TextureLoader

Properties

transcoderResponse

static transcoderResponse: Map<string, Promise<Response>>

Defined in: packages/charm/src/helpers/KTX2Loader.ts:31

Methods

decode()

decode(container): Promise<KTX2Container>

Defined in: packages/charm/src/helpers/KTX2Loader.ts:123

Decode a ktx2 container that contains compressed data.

Parameters

container

KTX2Container

Texture data in KTX2 format

Returns

Promise<KTX2Container>

Container for texture after decode

---

load()

load(url): Promise<KTX2Container>

Defined in: packages/charm/src/helpers/KTX2Loader.ts:88

Parse the input data and create a decoded ktx2 container

Parameters

url

string

KTX2 filename

Returns

Promise<KTX2Container>

Container for texture

---

parse()

parse(buffer): Promise<KTX2Container>

Defined in: packages/charm/src/helpers/KTX2Loader.ts:114

Similar to load but parses data from an arraybuffer.

Parameters

buffer

Uint8Array

Texture data in KTX2 format

Returns

Promise<KTX2Container>

Container for texture

---

parseContainer()

parseContainer(buffer): KTX2Container

Defined in: packages/charm/src/helpers/KTX2Loader.ts:105

Parse the input data and return a ktx2 container without decoding content

Parameters

buffer

Uint8Array

KTX2 arraybuffer

Returns

KTX2Container

Container for texture

---

setTranscoderWasm()

setTranscoderWasm(wasmbuf): Promise<WebAssemblyInstantiatedSource>

Defined in: packages/charm/src/helpers/KTX2Loader.ts:75

Set the wasm transcoder from arraybuffer. In a browser environment, the transcoder will be set automatically during decode. In node, however, the transcoder must be set from file content prior to decoding.

Parameters

wasmbuf

wasm file content

ArrayBuffer | Uint8Array<ArrayBufferLike>

Returns

Promise<WebAssemblyInstantiatedSource>

Webassembly instance of the transcoder