Skip to content

WasmGPU | Documentation

WasmGPU.create

WasmGPU.create¶

Summary¶

WasmGPU.create initializes WebGPU + WebAssembly and returns a ready engine instance bound to a canvas. Use this as the entry point for all rendering, compute, interaction, and interop workflows. The call is asynchronous because device/context initialization and WASM startup happen before the engine is returned.

Syntax¶

WasmGPU.create(canvas: HTMLCanvasElement, descriptor?: WasmGPUDescriptor): Promise<WasmGPU>
const wgpu = await WasmGPU.create(canvas, descriptor);

Parameters¶

Name	Type	Required	Description
`canvas`	`HTMLCanvasElement`	Yes	Canvas that receives GPU presentation and input events for engine subsystems.
`descriptor`	`WasmGPUDescriptor`	No	Renderer initialization options such as antialiasing, power preference, and frustum-culling behavior.

Returns¶

Promise<WasmGPU> - Resolves to an initialized WasmGPU engine instance.

Type Details¶

WasmGPUDescriptor¶

type WasmGPUDescriptor = RendererDescriptor & {
    // Future options: physics, audio, etc.
};

RendererDescriptor¶

type RendererDescriptor = {
    antialias?: boolean;
    powerPreference?: "high-performance" | "low-power";
    canvasFormat?: GPUTextureFormat;
    frustumCulling?: boolean;
    frustumCullingStats?: boolean;
};

Example¶

const canvas = document.querySelector("canvas");
const descriptor = { antialias: true, powerPreference: "high-performance" };
const wgpu = await WasmGPU.create(canvas, descriptor);
console.log(wgpu.gpu.format);

See Also¶