WebGL2RenderingContext: clientWaitSync() 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.

See full compatibility

Note: This feature is available in Web Workers.

The WebGL2RenderingContext.clientWaitSync() method of the WebGL 2 API blocks and waits for a WebGLSync object to become signaled or a given timeout to be passed.

Syntax

clientWaitSync(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. May be gl.SYNC_FLUSH_COMMANDS_BIT.
timeout: A GLint64 specifying a timeout (in nanoseconds) for which to wait for the sync object to become signaled. Must not be larger than gl.MAX_CLIENT_WAIT_TIMEOUT_WEBGL.

Return value

A GLenum indicating the sync object's status.

gl.ALREADY_SIGNALED: Indicates that the sync object was signaled when this method was called.
gl.TIMEOUT_EXPIRED: Indicates that the timeout time passed and that the sync object did not become signaled.
gl.CONDITION_SATISFIED: Indicates that the sync object was signaled before the timeout expired.
gl.WAIT_FAILED: Indicates that an error occurred during the execution.

Examples

const sync = gl.fenceSync(gl.SYNC_GPU_COMMANDS_COMPLETE, 0);
const status = gl.clientWaitSync(sync, 0, 0);

Specifications

Specification
WebGL 2.0 Specification # 3.7.14

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`clientWaitSync`	Chrome – Full support Chrome 56 (Release date: 2017-01-25) footnote Full support	Edge – Full support Edge 79 (Release date: 2020-01-15) footnote Full support	Firefox – Full support Firefox 51 (Release date: 2017-01-24) footnote Full support	Opera – Full support Opera 43 (Release date: 2017-02-07) footnote Full support	Safari – Full support Safari 15 (Release date: 2021-09-20) footnote Full support	Chrome Android – Full support Chrome Android 58 (Release date: 2017-04-25) footnote Full support	Firefox for Android – Full support Firefox for Android 51 (Release date: 2017-01-24) footnote Full support	Opera Android – Full support Opera Android 43 (Release date: 2017-09-27) footnote Full support	Safari on iOS – Full support Safari on iOS 15 (Release date: 2021-09-20) footnote Full support	Samsung Internet – Full support Samsung Internet 7 (Release date: 2018-03-16) footnote Full support	WebView Android – Full support WebView Android 58 (Release date: 2017-04-25) footnote Full support	WebView on iOS – Full support WebView on iOS 15 (Release date: 2021-09-20) footnote Full support

Tip: you can click/tap on a cell for more information.

Full support: Full support