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
WebGLSyncobject on which to wait on. - flags
- A
GLbitfieldspecifying a bitwise combination of flags controlling the flushing behavior. May begl.SYNC_FLUSH_COMMANDS_BIT. - timeout
- A
GLint64specifying 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 thetimeouttime passed and that the sync object did not become signaled.gl.CONDITION_SATISFIED: Indicates that the sync object was signaled before thetimeoutexpired.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.
| Feature | Chrome | Firefox | Edge | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic Support | 56 | 51.0 | (No) | (No) | 43 | (No) |
| Feature | Android | Chrome for Android | Edge mobile | Firefox for Android | IE mobile | Opera Android | iOS Safari |
|---|---|---|---|---|---|---|---|
| Basic Support | (No) | (No) | (No) | (No) | (No) | (No) | (No) |