WebGL2RenderingContext: getActiveUniformBlockParameter() 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.getActiveUniformBlockParameter() method of the WebGL 2 API retrieves information about an active uniform block within a WebGLProgram.

Syntax

js
getActiveUniformBlockParameter(program, uniformBlockIndex, pname)

Parameters

program

A WebGLProgram containing the active uniform block.

uniformBlockIndex

A GLuint specifying the index of the active uniform block within the program.

pname

A GLenum specifying which information to query. Possible values:

gl.UNIFORM_BLOCK_BINDING

Returns a GLuint indicating the uniform buffer binding point.

gl.UNIFORM_BLOCK_DATA_SIZE

Returns a GLuint indicating the minimum total buffer object size.

gl.UNIFORM_BLOCK_ACTIVE_UNIFORMS

Returns a GLuint indicating the number of active uniforms in the uniform block.

gl.UNIFORM_BLOCK_ACTIVE_UNIFORM_INDICES

Returns a Uint32Array indicating the list of active uniforms in the uniform block.

gl.UNIFORM_BLOCK_REFERENCED_BY_VERTEX_SHADER

Returns a GLboolean indicating whether the uniform block is referenced by the vertex shader.

gl.UNIFORM_BLOCK_REFERENCED_BY_FRAGMENT_SHADER

Returns a GLboolean indicating whether the uniform block is referenced by the fragment shader.

Return value

Depends on which information is requested using the pname parameter. If an error occurs, null is returned.

Examples

js
const blockSize = gl.getActiveUniformBlockParameter(
  program,
  blockIndex,
  gl.UNIFORM_BLOCK_DATA_SIZE,
);

Specifications

Specification
WebGL 2.0 Specification
# 3.7.16

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
getActiveUniformBlockParameter
Chrome – Full support
Chrome 56 (Release date: 2017-01-25)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – Full support
Firefox 51 (Release date: 2017-01-24)
footnote Full support
Opera – Full support
Opera 43 (Release date: 2017-02-07)
footnote Full support
Safari – Full support
Safari 15 (Release date: 2021-09-20)
footnote Full support
Chrome Android – Full support
Chrome Android 58 (Release date: 2017-04-25)
footnote Full support
Firefox for Android – Full support
Firefox for Android 51 (Release date: 2017-01-24)
footnote Full support
Opera Android – Full support
Opera Android 43 (Release date: 2017-09-27)
footnote Full support
Safari on iOS – Full support
Safari on iOS 15 (Release date: 2021-09-20)
footnote Full support
Samsung Internet – Full support
Samsung Internet 7 (Release date: 2018-03-16)
footnote Full support
WebView Android – Full support
WebView Android 58 (Release date: 2017-04-25)
footnote Full support
WebView on iOS – Full support
WebView on iOS 15 (Release date: 2021-09-20)
footnote Full support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

See also