Skip to content

OverlaySystem.interactionThrottleMs

Summary

OverlaySystem.interactionThrottleMs is the active-interaction update throttle interval in milliseconds. While interaction is active, updates may be skipped until this interval elapses unless force is used.

Syntax

OverlaySystem.interactionThrottleMs: number
const ms = overlay.interactionThrottleMs;

Parameters

This property does not take parameters.

Returns

number - Interaction update throttle interval in milliseconds.

Type Details

// Read-only numeric property.

Example

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

const overlay = wgpu.createOverlay.system({ interactionThrottleMs: 20 });
console.log(overlay.interactionThrottleMs);

See Also