We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS

WebGL2RenderingContext.getActiveUniformBlockParameter()

This is an experimental technology
Check 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.0
The definition of 'getActiveUniformBlockParameter' in that specification.
Editor's Draft Initial definition for WebGL.
OpenGL ES 3.0
The definition of 'glGetActiveUniformBlockiv' in that specification.
Standard Man page of the (similar) OpenGL API.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support56 No51 No43 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support5858 No5143 No7.0

See also

Document Tags and Contributors

Contributors to this page: fscholz, teoli
Last updated by: fscholz,