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 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
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | No support [2] | Nightly build [1] | No support | No support | No support |
Feature | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Basic support | No support | No support | No support | No support | No support | No support |
[1] WebGL 2 is enabled by default in Firefox Nightly. To enable it in a release version of Firefox, set the preference webgl.enable-prototype-webgl2
to true
in about:config.
[2] To use an experimental implementation of WebGL 2 in Chrome, you have to start Chrome with the runtime flag --enable-unsafe-es3-apis
.