WebGL2RenderingContext.getQuery()

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.getQuery() method of the WebGL 2 API returns the currently active WebGLQuery for the target, or null.

Syntax

WebGLQuery gl.getQuery(target, pname);

Parameters

target
A GLenum specifying the target of the query. Possible values:
  • gl.ANY_SAMPLES_PASSED: Specifies an occlusion query: these queries detect whether an object is visible (whether the scoped drawing commands pass the depth test and if so, how many samples pass).
  • gl.ANY_SAMPLES_PASSED_CONSERVATIVE: Same as above above, but less accurate and faster version.
  • gl.TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN: Number of primitives that are written to transform feedback buffers.
pname
A GLenum specifying the query object target. Must be gl.CURRENT_QUERY.

Return value

A WebGLQuery object.

Examples

var currentQuery = gl.getQuery(gl.ANY_SAMPLES_PASSED, gl.CURRENT_QUERY);

Specifications

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