PixiJS

Class: TranscoderWorker

PIXI.BasisParser.TranscoderWorker

Worker class for transcoding *.basis files in background threads.

To enable asynchronous transcoding, you need to provide the URL to the basis_universal transcoding library.

Members

PIXI.BasisParser.TranscoderWorker.bindingURL string static

URL for the script containing the basis_universal library.

PIXI.BasisParser.TranscoderWorker.onTranscoderInitialized static

a promise that when reslved means the transcoder is ready to be used

PIXI.BasisParser.TranscoderWorker.workerURL string static

Generated URL for the transcoder worker script.

onMessage protected

Handles responses from the web-worker

Methods

PIXI.BasisParser.TranscoderWorker.loadTranscoder (jsURL, wasmURL) Promise<[void, void]> static

TranscoderWorker.ts:168

Loads the transcoder source code

Name Type Description
jsURL string

URL to the javascript basis transcoder
wasmURL string

URL to the wasm basis transcoder
Returns:
Type Description
Promise<[void, void]> A promise that resolves when both the js and wasm transcoders have been loaded.

PIXI.BasisParser.TranscoderWorker.setTranscoder (jsSource, wasmSource) void static

TranscoderWorker.ts:192

Set the transcoder source code directly

Name Type Description
jsSource string

source for the javascript basis transcoder
wasmSource ArrayBuffer

source for the wasm basis transcoder

initAsync () Promise<void>

TranscoderWorker.ts:90
Returns:
Type Description
Promise<void> a promise that is resolved when the web-worker is initialized

transcodeAsync (basisData, rgbaFormat, rgbFormat) Promise<ITranscodeResponse>

TranscoderWorker.ts:96

Creates a promise that will resolve when the transcoding of a *.basis file is complete.

Name Type Description
basisData Uint8Array

*.basis file contents
rgbaFormat BASIS_FORMATS

transcoding format for RGBA files
rgbFormat BASIS_FORMATS

transcoding format for RGB files
Returns:
Type Description
Promise<ITranscodeResponse> a promise that is resolved with the transcoding response of the web-worker