glValidateProgram - Validates a program object
Contents
Associated Gets
glGetProgram() with arguments program and GL_VALIDATE_STATUSglGetProgramInfoLog() with argument programglIsProgram()
C Specification
voidglValidateProgram(GLuintprogram);
Copyright
Copyright © 2003-2005 3Dlabs Inc. Ltd.
Copyright © 2010-2014 Khronos Group
[FIXME: source] 11/18/2024 GLVALIDATEPROGRAM(3G)
Description
glValidateProgram checks to see whether the executables contained in program can execute given the
current OpenGL state. The information generated by the validation process will be stored in program's
information log. The validation information may consist of an empty string, or it may be a string
containing information about how the current program object interacts with the rest of current OpenGL
state. This provides a way for OpenGL implementers to convey more information about why the current
program is inefficient, suboptimal, failing to execute, and so on.
The status of the validation operation will be stored as part of the program object's state. This value
will be set to GL_TRUE if the validation succeeded, and GL_FALSE otherwise. It can be queried by calling
glGetProgram() with arguments program and GL_VALIDATE_STATUS. If validation is successful, program is
guaranteed to execute given the current state. Otherwise, program is guaranteed to not execute.
This function is typically useful only during application development. The informational string stored in
the information log is completely implementation dependent; therefore, an application should not expect
different OpenGL implementations to produce identical information strings.
Errors
GL_INVALID_VALUE is generated if program is not a value generated by OpenGL.
GL_INVALID_OPERATION is generated if program is not a program object.
Name
glValidateProgram - Validates a program object
Notes
This function mimics the validation operation that OpenGL implementations must perform when rendering
commands are issued while programmable shaders are part of current state. The error GL_INVALID_OPERATION
will be generated by any command that triggers the rendering of geometry if:
• any two active samplers in the current program object are of different types, but refer to the same
texture image unit,
• the number of active samplers in the program exceeds the maximum number of texture image units
allowed.
It may be difficult or cause a performance degradation for applications to catch these errors when
rendering commands are issued. Therefore, applications are advised to make calls to glValidateProgram to
detect these issues during application development.
Parameters
program
Specifies the handle of the program object to be validated.
See Also
glLinkProgram(), glUseProgram()
Version Support
┌───────────────────┬───────────────────────────────────────────────────────────────────────┐
│ │ OpenGLVersion │
├───────────────────┼─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┤
│ Function │ 2.0 │ 2.1 │ 3.0 │ 3.1 │ 3.2 │ 3.3 │ 4.0 │ 4.1 │ 4.2 │ 4.3 │ 4.4 │ 4.5 │
│ / │ │ │ │ │ │ │ │ │ │ │ │ │
│ Feature │ │ │ │ │ │ │ │ │ │ │ │ │
│ Name │ │ │ │ │ │ │ │ │ │ │ │ │
├───────────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
│ glValidateProgram │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │ ✔ │
└───────────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
