This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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 begl.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 thangl.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 thetimeout
time passed and that the sync object did not become signaled.gl.CONDITION_SATISFIED
: Indicates that the sync object was signaled before thetimeout
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
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
clientWaitSync | Chrome Full support 56 | Edge Full support 79 | Firefox Full support 51 | IE No support No | Opera Full support 43 | Safari No support No | WebView Android Full support 58 | Chrome Android Full support 58 | Firefox Android Full support 51 | Opera Android Full support 43 | Safari iOS No support No | Samsung Internet Android Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support