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.
The
WebGL2RenderingContext.getActiveUniformBlockParameter()
method of the WebGL 2 API retrieves
information about an active uniform block within a WebGLProgram
.
Syntax
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
const blockSize = gl.getActiveUniformBlockParameter(
program,
blockIndex,
gl.UNIFORM_BLOCK_DATA_SIZE,
);
Specifications
Specification |
---|
WebGL 2.0 Specification # 3.7.16 |
Browser compatibility
BCD tables only load in the browser