WebGL2RenderingContext.getUniformBlockIndex()

The WebGL2RenderingContext.getUniformBlockIndex() method of the WebGL 2 API retrieves the index of a uniform block within a WebGLProgram.

Syntax

GLuint gl.getUniformBlockIndex(program, uniformBlockName);

Parameters

program
A WebGLProgram containing the uniform block.
uniformName
A DOMString specifying the name of the uniform block to whose index to retrieve.

Return value

A GLuint indicating the uniform block index.

Examples

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

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

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also