GLAPI/glGetProgramInfoLog: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Renaming category: 'GL 4 API Shader Program Creation' to 'Core API Ref Shader Program Creation'.
m Bot: Adding better formatting.
 
(3 intermediate revisions by the same user not shown)
Line 8: Line 8:
== Function Definition ==
== Function Definition ==


   void '''glGetProgramInfoLog'''(GLuint ''program'', GLsizei ''maxLength'', GLsizei *''length'', GLchar *''infoLog'');
   void '''glGetProgramInfoLog'''(GLuint {{param|program}}, GLsizei {{param|maxLength}}, GLsizei *{{param|length}}, GLchar *{{param|infoLog}});


; program
; program
Line 15: Line 15:
: Specifies the size of the character buffer for storing the returned information log.
: Specifies the size of the character buffer for storing the returned information log.
; length
; length
: Returns the length of the string returned in ''infoLog'' (excluding the null terminator).
: Returns the length of the string returned in {{param|infoLog}} (excluding the null terminator).
; infoLog
; infoLog
: Specifies an array of characters that is used to return the information log.
: Specifies an array of characters that is used to return the information log.
Line 23: Line 23:
'''glGetProgramInfoLog''' returns the information log for the specified program object. The information log for a program object is modified when the program object is linked or validated. The string that is returned will be null terminated.
'''glGetProgramInfoLog''' returns the information log for the specified program object. The information log for a program object is modified when the program object is linked or validated. The string that is returned will be null terminated.


'''glGetProgramInfoLog''' returns in ''infoLog'' as much of the information log as it can, up to a maximum of ''maxLength'' characters. The number of characters actually returned, excluding the null termination character, is specified by ''length''. If the length of the returned string is not required, a value of {{code|NULL}} can be passed in the ''length'' argument. The size of the buffer required to store the returned information log can be obtained by calling [[GLAPI/glGetProgram|glGetProgram]] with the value {{code|GL_INFO_LOG_LENGTH}}.
'''glGetProgramInfoLog''' returns in {{param|infoLog}} as much of the information log as it can, up to a maximum of {{param|maxLength}} characters. The number of characters actually returned, excluding the null termination character, is specified by {{param|length}}. If the length of the returned string is not required, a value of {{code|NULL}} can be passed in the {{param|length}} argument. The size of the buffer required to store the returned information log can be obtained by calling {{apifunc|glGetProgram}} with the value {{enum|GL_INFO_LOG_LENGTH}}.


The information log for a program object is either an empty string, or a string containing information about the last link operation, or a string containing information about the last validation operation. It may contain diagnostic messages, warning messages, and other information. When a program object is created, its information log will be a string of length 0.
The information log for a program object is either an empty string, or a string containing information about the last link operation, or a string containing information about the last validation operation. It may contain diagnostic messages, warning messages, and other information. When a program object is created, its information log will be a string of length 0.
Line 33: Line 33:
== Errors ==
== Errors ==


{{code|GL_INVALID_VALUE}} is generated if ''program'' is not a value generated by OpenGL.
{{enum|GL_INVALID_VALUE}} is generated if {{param|program}} is not a value generated by OpenGL.


{{code|GL_INVALID_OPERATION}} is generated if ''program'' is not a program object.
{{enum|GL_INVALID_OPERATION}} is generated if {{param|program}} is not a program object.


{{code|GL_INVALID_VALUE}} is generated if ''maxLength'' is less than 0.
{{enum|GL_INVALID_VALUE}} is generated if {{param|maxLength}} is less than 0.


== Associated Gets ==
== Associated Gets ==


[[GLAPI/glGetProgram|glGetProgram]] with argument {{code|GL_INFO_LOG_LENGTH}}
{{apifunc|glGetProgram}} with argument {{enum|GL_INFO_LOG_LENGTH}}


[[GLAPI/glIsProgram|glIsProgram]]
{{apifunc|glIsProgram}}


== See Also ==
== See Also ==


[[GLAPI/glCompileShader|glCompileShader]], [[GLAPI/glGetShaderInfoLog|glGetShaderInfoLog]], [[GLAPI/glLinkProgram|glLinkProgram]], [[GLAPI/glValidateProgram|glValidateProgram]]
{{apifunc|glGetShaderInfoLog}}, {{apifunc|glCreateShaderProgram}}, {{apifunc|glLinkProgram}}, {{apifunc|glValidateProgram}}


== Copyright ==
== Copyright ==
Line 55: Line 55:
[[Category:Core API Reference|GetProgramInfoLog]]
[[Category:Core API Reference|GetProgramInfoLog]]
[[Category:Core API Ref Shader Program Creation|GetProgramInfoLog]]
[[Category:Core API Ref Shader Program Creation|GetProgramInfoLog]]
[[Category:Program Object API State Functions|GetProgramInfoLog]]

Latest revision as of 09:59, 15 August 2013

glGetProgramInfoLog
Core in version 4.6
Core since version 2.0

glGetProgramInfoLog: Returns the information log for a program object

Function Definition

 void glGetProgramInfoLog(GLuint program​, GLsizei maxLength​, GLsizei *length​, GLchar *infoLog​);
program
Specifies the program object whose information log is to be queried.
maxLength
Specifies the size of the character buffer for storing the returned information log.
length
Returns the length of the string returned in infoLog​ (excluding the null terminator).
infoLog
Specifies an array of characters that is used to return the information log.

Description

glGetProgramInfoLog returns the information log for the specified program object. The information log for a program object is modified when the program object is linked or validated. The string that is returned will be null terminated.

glGetProgramInfoLog returns in infoLog​ as much of the information log as it can, up to a maximum of maxLength​ characters. The number of characters actually returned, excluding the null termination character, is specified by length​. If the length of the returned string is not required, a value of NULL can be passed in the length​ argument. The size of the buffer required to store the returned information log can be obtained by calling glGetProgram with the value GL_INFO_LOG_LENGTH.

The information log for a program object is either an empty string, or a string containing information about the last link operation, or a string containing information about the last validation operation. It may contain diagnostic messages, warning messages, and other information. When a program object is created, its information log will be a string of length 0.

Notes

The information log for a program object is the OpenGL implementer's primary mechanism for conveying information about linking and validating. Therefore, the information log can be helpful to application developers during the development process, even when these operations are successful. Application developers should not expect different OpenGL implementations to produce identical information logs.

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.

GL_INVALID_VALUE is generated if maxLength​ is less than 0.

Associated Gets

glGetProgram with argument GL_INFO_LOG_LENGTH

glIsProgram

See Also

glGetShaderInfoLog, glCreateShaderProgram, glLinkProgram, glValidateProgram

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/.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glGetProgramInfoLog&oldid=11027"