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 aGLuint
indicating the uniform buffer binding point.gl.UNIFORM_BLOCK_DATA_SIZE
: Returns aGLuint
indicating the minimum total buffer object size.gl.UNIFORM_BLOCK_ACTIVE_UNIFORMS
: Returns aGLuint
indicating the number of active uniforms in the uniform block.gl.UNIFORM_BLOCK_ACTIVE_UNIFORM_INDICES
: Returns aUint32Array
indicating the list of active uniforms in the uniform block.gl.UNIFORM_BLOCK_REFERENCED_BY_VERTEX_SHADER
: Returns aGLboolean
indicating whether the uniform block is referenced by the vertex shader.gl.UNIFORM_BLOCK_REFERENCED_BY_FRAGMENT_SHADER
: Returns aGLboolean
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
BCD tables only load in the browser
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.