glGetProgramResourceLocation.3G - Man Page

query the location of a named resource within a program

C Specification

GLint glGetProgramResourceLocation(GLuint program, GLenum programInterface, const char * name);

Parameters

program

The name of a program object whose resources to query.

programInterface

A token identifying the interface within program containing the resource named name.

name

The name of the resource to query the location of.

Description

glGetProgramResourceLocation returns the location assigned to the variable named name in interface programInterface of program object program. program must be the name of a program that has been linked successfully. programInterface must be one of GL_UNIFORM, GL_PROGRAM_INPUT, GL_PROGRAM_OUTPUT, GL_VERTEX_SUBROUTINE_UNIFORM, GL_TESS_CONTROL_SUBROUTINE_UNIFORM, GL_TESS_EVALUATION_SUBROUTINE_UNIFORM, GL_GEOMETRY_SUBROUTINE_UNIFORM, GL_FRAGMENT_SUBROUTINE_UNIFORM, GL_COMPUTE_SUBROUTINE_UNIFORM, or GL_TRANSFORM_FEEDBACK_BUFFER.

The value -1 will be returned if an error occurs, if name does not identify an active variable on programInterface, or if name identifies an active variable that does not have a valid location assigned, as described above. The locations returned by these commands are the same locations returned when querying the GL_LOCATION and GL_LOCATION_INDEX resource properties.

A string provided to glGetProgramResourceLocation is considered to match an active variable if:

Any other string is considered not to identify an active variable. If the string specifies an element of an array variable, glGetProgramResourceLocation returns the location assigned to that element. If it specifies the base name of an array, it identifies the resources associated with the first element of the array.

Errors

GL_INVALID_VALUE is generated if program is not the name of an existing program object.

GL_INVALID_ENUM is generated if programInterface is not one of the accepted interface types.

GL_INVALID_OPERATION is generated if program has not been linked successfully.

Version Support

OpenGL Version
Function / Feature Name2.02.13.03.13.23.34.04.14.24.34.44.5
glGetProgramResourceLocation---------

See Also

glGetProgramResourceName(), glGetProgramResourceIndex(), glGetProgramResource(), glGetProgramResourceLocationIndex().

Referenced By

glGetProgramResource.3G(3), glGetProgramResourceIndex.3G(3), glGetProgramResourceName.3G(3).

01/24/2024