glGetProgramiv

Returns a parameter from a program object

Signature

glGetProgramiv( GLuint ( program ) , GLenum ( pname ) , GLint *( params ) )-> void
glGetProgramiv( program , pname , params )

Parameters

VariablesDescription
program
Specifies the program object to be queried.
pname
Specifies the object parameter. Accepted symbolic names are GL_ACTIVE_ATTRIBUTES , GL_ACTIVE_ATTRIBUTE_MAX_LENGTH , GL_ACTIVE_UNIFORMS , GL_ACTIVE_UNIFORM_BLOCKS , GL_ACTIVE_UNIFORM_BLOCK_MAX_NAME_LENGTH , GL_ACTIVE_UNIFORM_MAX_LENGTH , GL_ATTACHED_SHADERS , GL_DELETE_STATUS , GL_INFO_LOG_LENGTH , GL_LINK_STATUS , GL_PROGRAM_BINARY_RETRIEVABLE_HINT , GL_TRANSFORM_FEEDBACK_BUFFER_MODE , GL_TRANSFORM_FEEDBACK_VARYINGS , GL_TRANSFORM_FEEDBACK_VARYING_MAX_LENGTH and GL_VALIDATE_STATUS .
params
Returns the requested object parameter.

Description

glGetProgramiv returns in params the value of a parameter for a specific program object. The following parameters are defined:
GL_ACTIVE_ATTRIBUTES
params returns the number of active attribute variables for program .
GL_ACTIVE_ATTRIBUTE_MAX_LENGTH
params returns the length of the longest active attribute name for program , including the null termination character (i.e., the size of the character buffer required to store the longest attribute name). If no active attributes exist, 0 is returned.
GL_ACTIVE_UNIFORM_BLOCKS
params returns the number of uniform blocks for program containing active uniforms.
GL_ACTIVE_UNIFORM_BLOCK_MAX_NAME_LENGTH
params returns the length of the longest active uniform block name for program , including the null termination character (i.e., the size of the character buffer required to store the longest uniform block name). If no active uniform blocks exist, 0 is returned.
GL_ACTIVE_UNIFORMS
params returns the number of active uniform variables for program .
GL_ACTIVE_UNIFORM_MAX_LENGTH
params returns the length of the longest active uniform variable name for program , including the null termination character (i.e., the size of the character buffer required to store the longest uniform variable name). If no active uniform variables exist, 0 is returned.
GL_ATTACHED_SHADERS
params returns the number of shader objects attached to program .
GL_DELETE_STATUS
params returns GL_TRUE if program is currently flagged for deletion, and GL_FALSE otherwise.
GL_INFO_LOG_LENGTH
params returns the number of characters in the information log for program including the null termination character (i.e., the size of the character buffer required to store the information log). If program has no information log, a value of 0 is returned.
GL_LINK_STATUS
params returns GL_TRUE if the last link operation on program was successful, and GL_FALSE otherwise.
GL_PROGRAM_BINARY_RETRIEVABLE_HINT
params returns the current value of whether the binary retrieval hint is enabled for program .
GL_TRANSFORM_FEEDBACK_BUFFER_MODE
params returns a symbolic constant indicating the buffer mode used when transform feedback is active. This may be GL_SEPARATE_ATTRIBS or GL_INTERLEAVED_ATTRIBS .
GL_TRANSFORM_FEEDBACK_VARYINGS
params returns the number of varying variables to capture in transform feedback mode for the program.
GL_TRANSFORM_FEEDBACK_VARYING_MAX_LENGTH
params returns the length of the longest variable name to be used for transform feedback, including the null-terminator.
GL_VALIDATE_STATUS
params returns GL_TRUE or if the last validation operation on program was successful, and GL_FALSE otherwise.

Notes

If an error is generated, no change is made to the contents of params .

Errors

GL_INVALID_VALUE is generated if program is not a value generated by OpenGL.
GL_INVALID_OPERATION is generated if program does not refer to a program object.
GL_INVALID_ENUM is generated if pname is not an accepted value.

Associated Gets

glGetActiveAttrib with argument program
glGetActiveUniform with argument program
glGetAttachedShaders with argument program
glGetProgramInfoLog with argument program
glIsProgram

API Version Support

glGetProgramiv

See Also

glAttachShader , glCreateProgram , glDeleteProgram , glGetShaderiv , glLinkProgram , glValidateProgram

Copyright

Copyright
2003-2005 3Dlabs Inc. Ltd. Copyright
2010-2014 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999.
http://opencontent.org/openpub/
.

Sample Code References

The following code samples have been found which appear to reference the functions described here. Take care that the code may be old, broken or not even use PyOpenGL.

glGetProgramiv
OpenGLContext OpenGLContext/scenegraph/shaders.py Lines: 505, 513
Visvis core/shaders.py Lines: 539
{GPL3} OpenGL-Programmable 05-shader.py Lines: 90
{GPL3} OpenGL-Programmable 07-attrib.py Lines: 107
{GPL3} OpenGL-Programmable 09-gles2.py Lines: 121
{GPL3} OpenGL-Programmable 06-perpixel.py Lines: 98
{GPL3} OpenGL-Programmable 10-gl3.2core.py Lines: 129
{GPL3} OpenGL-Programmable 08-pbo.py Lines: 107

Copyright Notices

This documentation is based on documentation licensed under the SGI Free Software License B.