Difference between revisions of "GLAPI/glValidateProgram"
m (Bot: Adjusting API page category.) |
m (Bot: Adding better formatting.) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
| − | void '''glValidateProgram'''(GLuint | + | void '''glValidateProgram'''(GLuint {{param|program}}); |
; program | ; program | ||
| Line 15: | Line 15: | ||
== Description == | == Description == | ||
| − | '''glValidateProgram''' checks to see whether the executables contained in | + | '''glValidateProgram''' checks to see whether the executables contained in {{param|program}} can execute given the current OpenGL state. The information generated by the validation process will be stored in {{param|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 {{ | + | The status of the validation operation will be stored as part of the program object's state. This value will be set to {{enum|GL_TRUE}} if the validation succeeded, and {{enum|GL_FALSE}} otherwise. It can be queried by calling {{apifunc|glGetProgram}} with arguments {{param|program}} and {{enum|GL_VALIDATE_STATUS}}. If validation is successful, {{param|program}} is guaranteed to execute given the current state. Otherwise, {{param|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. | 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. | ||
| Line 23: | Line 23: | ||
== Notes == | == 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 {{ | + | 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 {{enum|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, | * any two active samplers in the current program object are of different types, but refer to the same texture image unit, | ||
| Line 33: | Line 33: | ||
== Errors == | == Errors == | ||
| − | {{ | + | {{enum|GL_INVALID_VALUE}} is generated if {{param|program}} is not a value generated by OpenGL. |
| − | {{ | + | {{enum|GL_INVALID_OPERATION}} is generated if {{param|program}} is not a program object. |
== Associated Gets == | == Associated Gets == | ||
| − | + | {{apifunc|glGetProgram}} with arguments {{param|program}} and {{enum|GL_VALIDATE_STATUS}} | |
| − | + | {{apifunc|glGetProgramInfoLog}} with argument {{param|program}} | |
| − | + | {{apifunc|glIsProgram}} | |
== See Also == | == See Also == | ||
| − | + | {{apifunc|glLinkProgram}}, {{apifunc|glUseProgram}}, {{apifunc|glValidateProgramPipeline}} | |
== Copyright == | == Copyright == | ||
| Line 53: | Line 53: | ||
Copyright © 2003-2005 3Dlabs Inc. Ltd. 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/ http://opencontent.org/openpub/]. | Copyright © 2003-2005 3Dlabs Inc. Ltd. 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/ http://opencontent.org/openpub/]. | ||
| − | [[Category:API Reference | + | [[Category:Core API Reference|ValidateProgram]] |
| − | [[Category: | + | [[Category:Core API Ref Shader Program Creation|ValidateProgram]] |
| + | [[Category:Program Object API State Functions|ValidateProgram]] | ||
Latest revision as of 10:05, 15 August 2013
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 2.0 | |
glValidateProgram: Validates a program object
Function Definition
void glValidateProgram(GLuint program);
- program
- Specifies the handle of the program object to be validated.
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.
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.
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.
Associated Gets
glGetProgram with arguments program and GL_VALIDATE_STATUS
glGetProgramInfoLog with argument program
See Also
glLinkProgram, glUseProgram, glValidateProgramPipeline
Copyright
Copyright © 2003-2005 3Dlabs Inc. Ltd. 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/.