WebGL2RenderingContext.waitSync()

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.waitSync() method of the WebGL 2 API returns immediately, but waits on the GL server until the given WebGLSync object is signaled.

The method is a no-op in the absence of the possibility of synchronizing between multiple GL contexts.

Syntax

void gl.waitSync(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. Must be 0 (exists for extensions only).
timeout
A GLint64 specifying a timeout the server should wait before continuing. Must be gl.TIMEOUT_IGNORED.

Return value

None.

Examples

var sync = gl.fenceSync(gl.SYNC_GPU_COMMANDS_COMPLETE, 0);
gl.waitSync(sync, 0, gl.TIMEOUT_IGNORED);

Specifications

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

Browser compatibility

FeatureChromeFirefoxEdgeInternet ExplorerOperaSafari
Basic Support5651.0(No)(No)43(No)
FeatureAndroidChrome for AndroidEdge mobileFirefox for AndroidIE mobileOpera AndroidiOS Safari
Basic Support(No)(No)(No)(No)(No)(No)(No)

See also

Document Tags and Contributors

 Contributors to this page: fscholz, teoli
 Last updated by: fscholz,