Skip to content

OverlaySystem.autoUpdate

Summary

OverlaySystem.autoUpdate indicates whether the system schedules updates automatically using requestAnimationFrame after invalidation. When false, call overlay.update(...) manually.

Syntax

OverlaySystem.autoUpdate: boolean
const enabled = overlay.autoUpdate;

Parameters

This property does not take parameters.

Returns

boolean - Whether automatic RAF-driven updates are enabled.

Type Details

// Read-only boolean property.

Example

const canvas = document.querySelector("canvas");
const wgpu = await WasmGPU.create(canvas);

const overlay = wgpu.createOverlay.system({ autoUpdate: false });
overlay.addLayer(wgpu.createOverlay.axisTriad());
overlay.update({ force: true });
console.log(overlay.autoUpdate);

See Also