WebGL2RenderingContext: getUniformBlockIndex() 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.getUniformBlockIndex() method of the WebGL 2 API retrieves the index of a uniform block within a WebGLProgram.

Syntax

js
getUniformBlockIndex(program, uniformBlockName)

Parameters

program

A WebGLProgram containing the uniform block.

uniformName

A string specifying the name of the uniform block to whose index to retrieve.

Return value

A GLuint indicating the uniform block index.

Examples

js
// Assuming a shader with the following declaration:
// uniform UBOData {
//   mat4 foo;
// } instanceName;

// use the block name, not the instance name:
const blockIndex = gl.getUniformBlockIndex(program, "UBOData");

Specifications

Specification
WebGL 2.0 Specification
# 3.7.16

Browser compatibility

BCD tables only load in the browser

See also