Class KTX2TextureTranscoder

KTX2 texture decompression strategy.

See @xeokit/sdk/ktx2 for usage.

Implements

TextureTranscoder

Index

Constructors

Methods

destroy init transcode

Constructors

constructor

new KTX2TextureTranscoder(
params: { transcoderPath?: string; workerLimit?: number },
): KTX2TextureTranscoder
Creates a new KTX2TextureTranscoder.
Parameters
- params: { transcoderPath?: string; workerLimit?: number }
  - OptionaltranscoderPath?: string
    Path to the Basis transcoder module that internally does the heavy lifting for our KTX2TextureTranscoder. If we omit this configuration, then our KTX2TextureTranscoder will load it from https://cdn.jsdelivr.net/npm/@xeokit/sdk/dist/basis/ by default. Therefore, make sure your application is connected to the internet if you wish to use the default transcoder path.
  - OptionalworkerLimit?: number
    The maximum number of Workers to use for transcoding.
Returns KTX2TextureTranscoder
- Defined in packages/sdk/src/ktx2/KTX2TextureTranscoder.ts:88

Methods

destroy

destroy(): void
Destroys this KTX2TextureTranscoder

Returns void
Implementation of TextureTranscoder.destroy
- Defined in packages/sdk/src/ktx2/KTX2TextureTranscoder.ts:161

init

init(capabilities: Capabilities): void
Initializes this transcoder.
Parameters
- capabilities: Capabilities
  A set of flags indicating the capabilities of this TextureTranscoder.
Returns void
Implementation of TextureTranscoder.init
- Defined in packages/sdk/src/ktx2/KTX2TextureTranscoder.ts:110

transcode

transcode(buffers: ArrayBuffer[], config?: {}): Promise<TextureCompressedParams>
Transcodes texture data from transcoded buffers.
Parameters
- buffers: ArrayBuffer[]
  Transcoded input texture data. Given as an array of buffers so that we can support multi-image textures, such as cube maps.
- config: {} = {}
  Transcoding options.
Returns Promise<TextureCompressedParams>
Transcoded output texture data.
Implementation of TextureTranscoder.transcode
- Defined in packages/sdk/src/ktx2/KTX2TextureTranscoder.ts:128