WebGL2RenderingContext: waitSync() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

Note: This feature is available in Web Workers.

The WebGL2RenderingContext.waitSync() method of the WebGL 2 API returns immediately, but waits on the GL server until the given WebGLSync object is signaled.

The method is a no-op in the absence of the possibility of synchronizing between multiple GL contexts.

Syntax

js
waitSync(sync, flags, timeout)

Parameters

sync

A WebGLSync object on which to wait on.

flags

A GLbitfield specifying a bitwise combination of flags controlling the flushing behavior. Must be 0 (exists for extensions only).

timeout

A GLint64 specifying a timeout the server should wait before continuing. Must be gl.TIMEOUT_IGNORED.

Return value

None (undefined).

Examples

js
const sync = gl.fenceSync(gl.SYNC_GPU_COMMANDS_COMPLETE, 0);
gl.waitSync(sync, 0, gl.TIMEOUT_IGNORED);

Specifications

Specification
WebGL 2.0 Specification
# 3.7.14

Browser compatibility

BCD tables only load in the browser

See also