Web/API/WebGL2RenderingContext/getActiveUniformBlockParameter

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The WebGL2RenderingContext.getActiveUniformBlockParameter() method of the WebGL 2 API retrieves information about an active uniform block within a WebGLProgram.

Syntax

any gl.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

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

Specifications

Specification	Status	Comment
WebGL 2.0The definition of 'getActiveUniformBlockParameter' in that specification.	Editor's Draft	Initial definition for WebGL.
OpenGL ES 3.0The definition of 'glGetActiveUniformBlockiv' in that specification.	Standard	Man page of the (similar) OpenGL API.

Browser compatibility

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.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`getActiveUniformBlockParameter`	Chrome Full support 56	Edge Full support 79	Firefox Full support 51	IE No support No	Opera Full support 43	Safari No support No	WebView Android Full support 58	Chrome Android Full support 58	Firefox Android Full support 51	Opera Android Full support 43	Safari iOS No support No	Samsung Internet Android Full support 7.0

Legend

Full support: Full support
No support: No support