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 aGLenum
indicating the type of the sync object (alwaysgl.SYNC_FENCE
).gl.SYNC_STATUS
: Returns aGLenum
indicating the status of the sync object (gl.SIGNALED
orgl.UNSIGNALED
).gl.SYNC_CONDITION
: Returns aGLenum
indicating the sync objects' condition (alwaysgl.SYNC_GPU_COMMANDS_COMPLETE
).gl.SYNC_FLAGS
: Returns aGLenum
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
BCD tables only load in the browser
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.