Class KTX2Parser

A KTX2 PIXI loader parser using the official Khronos KTX module in a worker.

Index

Properties

detectKTX2 loadKTX2 resolveKTX2TextureUrl WASM_PATH

Accessors

initialized module

Methods

initialize loadResource parse

Properties

`Static`detectKTX2

detectKTX2: object = ...

A PIXI asset detection parser for KTX2 textures.

`Static`loadKTX2

loadKTX2: object = ...

A PIXI asset loader parser for KTX2 textures.

`Static`resolveKTX2TextureUrl

resolveKTX2TextureUrl: object = ...

A PIXI asset resolver for KTX2 texture URLs.

`Static`WASM_PATH

WASM_PATH: string = "scripts/ktx2/libktx.wasm"

The default path to the Khronos libktx WebAssembly module.

Accessors

`Static`initialized

get initialized(): boolean
Has the Khronos KTX module been initialized?

Returns boolean

`Static`module

get module(): object | null
The initialized Khronos KTX module.

Returns object | null

Methods

`Static`initialize

initialize(options?: KTX2ParserInitOptions): Promise<object>
Initialize the Khronos KTX module. The main-thread module remains available to callers; texture loading uses a separate worker instance.
Parameters
- Optionaloptions: KTX2ParserInitOptions = {}
  Initialization options.
Returns Promise<object>
The initialized Khronos KTX module.

`Static`loadResource

loadResource(
url: string,
options?: KTX2ParserParseOptions,
): Promise<CompressedTextureResource>
Load a KTX2 URL as a PIXI compressed texture resource.
Parameters
- url: string
  The texture URL.
- Optionaloptions: KTX2ParserParseOptions = {}
  Parser options.
Returns Promise<CompressedTextureResource>
The compressed texture resource.

`Static`parse

parse(
data: Uint8Array | ArrayBuffer,
options?: KTX2ParserParseOptions,
): Promise<CompressedTextureResource>
Parse KTX2 data in a worker and create a PIXI compressed texture resource. The input remains available to the caller unless transfer is explicitly enabled.
Parameters
- data: Uint8Array | ArrayBuffer
  The KTX2 file data.
- Optionaloptions: KTX2ParserParseOptions = {}
  Parser options.
Returns Promise<CompressedTextureResource>
The compressed texture resource.