W3cubDocs

/DOM

WebGL2RenderingContext.clientWaitSync

This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.

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

GLenum gl.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

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

Specifications

Specification Status Comment
WebGL 2.0
The definition of 'clientWaitSync' in that specification.
Editor's Draft Initial definition for WebGL.
OpenGL ES 3.0
The definition of 'glClientWaitSync' in that specification.
Standard Man page of the (similar) OpenGL API.

Browser compatibility

Feature Chrome Edge Firefox Internet Explorer Opera Safari Servo
Basic Support 56 No support 51.0 No support 43 No support No support
Feature Android Chrome for Android Edge Mobile Firefox for Android IE Mobile Opera Mobile Safari Mobile
Basic Support No support No support No support No support No support No support No support

See also

© 2005–2017 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/clientWaitSync