logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

glGetUniformBlockIndex - retrieve the index of a named uniform block

C Specification

GLuintglGetUniformBlockIndex(GLuintprogram,constGLchar*uniformBlockName);

Description

glGetUniformBlockIndex retrieves the index of a uniform block within program.

       program must be the name of a program object for which the command glLinkProgram() must have been called
       in the past, although it is not required that glLinkProgram() must have succeeded. The link could have
       failed because the number of active uniforms exceeded the limit.

       uniformBlockName must contain a nul-terminated string specifying the name of the uniform block.

       glGetUniformBlockIndex returns the uniform block index for the uniform block named uniformBlockName of
       program. If uniformBlockName does not identify an active uniform block of program, glGetUniformBlockIndex
       returns the special identifier, GL_INVALID_INDEX. Indices of the active uniform blocks of a program are
       assigned in consecutive order, beginning with zero.

Errors

GL_INVALID_OPERATION is generated if program is not the name of a program object for which
       glLinkProgram() has been called in the past.

Name

       glGetUniformBlockIndex - retrieve the index of a named uniform block

Notes

glGetUniformBlockIndex is available only if the GL version is 3.1 or greater.

Parameters

program
           Specifies the name of a program containing the uniform block.

       uniformBlockName
           Specifies the address an array of characters to containing the name of the uniform block whose index
           to retrieve.

See Also

glGetActiveUniformBlockName(), glGetActiveUniformBlock(), glLinkProgram()

Version Support

       ┌────────────────────────┬───────────────────────────────────────────────────────────────────────┐
       │                        │                OpenGLVersion                                         │
       ├────────────────────────┼─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┤
       │ Function2.02.13.03.13.23.34.04.14.24.34.44.5 │
       │ /                      │     │     │     │     │     │     │     │     │     │     │     │     │
       │ Feature                │     │     │     │     │     │     │     │     │     │     │     │     │
       │ Name                   │     │     │     │     │     │     │     │     │     │     │     │     │
       ├────────────────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
       │ glGetUniformBlockIndex │  -  │  -  │  -  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │
       └────────────────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘

See Also