WebGL2RenderingContext: getSyncParameter() method
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.
Note: This feature is available in Web Workers.
The WebGL2RenderingContext.getSyncParameter()
method of
the WebGL 2 API returns parameter
information of a WebGLSync
object.
Syntax
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 (alwaysgl.SYNC_FENCE
). gl.SYNC_STATUS
-
Returns a
GLenum
indicating the status of the sync object (gl.SIGNALED
orgl.UNSIGNALED
). gl.SYNC_CONDITION
-
Returns a
GLenum
indicating the sync objects' condition (alwaysgl.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
const sync = gl.fenceSync(gl.SYNC_GPU_COMMANDS_COMPLETE, 0);
gl.getSyncParameter(sync, gl.SYNC_STATUS);
Specifications
Specification |
---|
WebGL 2.0 Specification # 3.7.14 |
Browser compatibility
BCD tables only load in the browser