WebGL2RenderingContext.getSyncParameter()

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.getSyncParameter() method of the WebGL 2 API returns parameter information of a WebGLSync object.

Syntax

any gl.getSyncParameter(sync, pname);

Parameters

sync
A WebGLSync object.
pname
A GLenum specifying which information to return. Possible values:
  • gl.OBJECT_TYPE: Returns a GLenum indicating the type of the sync object (always gl.SYNC_FENCE).
  • gl.SYNC_STATUS: Returns a GLenum indicating the status of the sync object (gl.SIGNALED or gl.UNSIGNALED).
  • gl.SYNC_CONDITION: Returns a GLenum indicating the sync objects' condition (always gl.SYNC_GPU_COMMANDS_COMPLETE).
  • gl.SYNC_FLAGS: Returns a GLenum indicating the flags with which the sync object was created (always 0 as no flags are supported).

Return value

Depends on the pname parameter, either a GLenum or a GLbitfield.

Examples

var sync = gl.fenceSync(gl.SYNC_GPU_COMMANDS_COMPLETE, 0);
gl.getSyncParameter(sync, gl.SYNC_STATUS);

Specifications

Specification Status Comment
WebGL 2.0
The definition of 'getSyncParameter' in that specification.
Editor's Draft Initial definition for WebGL.
OpenGL ES 3.0
The definition of 'glGetSynciv' 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,