W3cubDocs

/Web APIs

WebGL2RenderingContext: clientWaitSync() method

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

js

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

js

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
clientWaitSync 56 79 51 No 43 15 58 58 51 43 15 7.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/clientWaitSync