Skip to content

1681-engine / index / AssetLoaderOptions

Interface: AssetLoaderOptions ​

Defined in: src/assets/AssetLoader.ts:33

Properties ​

addFont? ​

ts
optional addFont?: (family, data, descriptors?) => Promise<void>;

Defined in: src/assets/AssetLoader.ts:48

Installs a font's bytes; defaults to a FontFace added to document.fonts.

Parameters ​

ParameterType
familystring
dataArrayBuffer
descriptors?FontFaceDescriptors

Returns ​

Promise<void>


audioContext? ​

ts
optional audioContext?: () => BaseAudioContext | null;

Defined in: src/assets/AssetLoader.ts:46

The context audio decodes through (default: the engine's sound context, sound.audioContext, once a gesture opened it). Null means "not yet": the bytes are kept and decoded on first decodeAudio.

Returns ​

BaseAudioContext | null


baseUrl? ​

ts
optional baseUrl?: string;

Defined in: src/assets/AssetLoader.ts:35

Prefix for relative URLs (default: none, so relative to the page).


concurrency? ​

ts
optional concurrency?: number;

Defined in: src/assets/AssetLoader.ts:37

Requests running at once (default 6).


fetch? ​

ts
optional fetch?: (url) => Promise<AssetResponse>;

Defined in: src/assets/AssetLoader.ts:39

For tests and custom transports: defaults to the global fetch.

Parameters ​

ParameterType
urlstring

Returns ​

Promise<AssetResponse>


toCanvas? ​

ts
optional toCanvas?: (blob) => Promise<HTMLCanvasElement>;

Defined in: src/assets/AssetLoader.ts:41

Turns image bytes into a canvas; defaults to createImageBitmap drawn onto a new canvas.

Parameters ​

ParameterType
blobBlob

Returns ​

Promise<HTMLCanvasElement>

Released under the MIT License.