WebGL2RenderingContext: getUniformBlockIndex() method

{{APIRef("WebGL")}}{{AvailableInWorkers}}

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

Syntax

getUniformBlockIndex(program, uniformBlockName)

Parameters

• program
  • : A {{domxref("WebGLProgram")}} containing the uniform block.
• uniformName
  • : A string specifying the name of the uniform block to whose index to retrieve.

Return value

A {{domxref("WebGL_API/Types", "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:
const blockIndex = gl.getUniformBlockIndex(program, "UBOData");

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("WebGL2RenderingContext.getUniformIndices()")}}