GLAPI/glGetProgramPipelineInfoLog: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
m Bot: Adding better formatting.
m Bot: Adding better formatting.
Line 24: Line 24:
'''glGetProgramPipelineInfoLog''' retrieves the info log for the program pipeline object {{param|pipeline}}. The info log, including its null terminator, is written into the array of characters whose address is given by {{param|infoLog}}. The maximum number of characters that may be written into {{param|infoLog}} is given by {{param|bufSize}}, and the actual number of characters written into {{param|infoLog}} is returned in the integer whose address is given by {{param|length}}. If {{param|length}} is {{code|NULL}}, no length is returned.
'''glGetProgramPipelineInfoLog''' retrieves the info log for the program pipeline object {{param|pipeline}}. The info log, including its null terminator, is written into the array of characters whose address is given by {{param|infoLog}}. The maximum number of characters that may be written into {{param|infoLog}} is given by {{param|bufSize}}, and the actual number of characters written into {{param|infoLog}} is returned in the integer whose address is given by {{param|length}}. If {{param|length}} is {{code|NULL}}, no length is returned.


The actual length of the info log for the program pipeline may be determined by calling {{apifunc|glGetProgramPipeline}} with {{param|pname}} set to {{code|GL_INFO_LOG_LENGTH}}.
The actual length of the info log for the program pipeline may be determined by calling {{apifunc|glGetProgramPipeline}} with {{param|pname}} set to {{enum|GL_INFO_LOG_LENGTH}}.


== Errors ==
== Errors ==


{{code|GL_INVALID_OPERATION}} is generated if {{param|pipeline}} is not a name previously returned from a call to {{apifunc|glGenProgramPipelines}} or if such a name has been deleted by a call to {{apifunc|glDeleteProgramPipelines}}.
{{enum|GL_INVALID_OPERATION}} is generated if {{param|pipeline}} is not a name previously returned from a call to {{apifunc|glGenProgramPipelines}} or if such a name has been deleted by a call to {{apifunc|glDeleteProgramPipelines}}.


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


{{apifunc|glGetProgramPipeline}} with parameter {{code|GL_INFO_LOG_LENGTH}}.
{{apifunc|glGetProgramPipeline}} with parameter {{enum|GL_INFO_LOG_LENGTH}}.


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

Revision as of 17:23, 29 April 2012

glGetProgramPipelineInfoLog
Core in version 4.6
Core since version 4.1
Core ARB extension ARB_separate_shader_objects

glGetProgramPipelineInfoLog: retrieve the info log string from a program pipeline object

Function Definition

 void glGetProgramPipelineInfoLog(GLuint pipeline​, GLsizei bufSize​, GLsizei *length​, GLchar *infoLog​);
pipeline
Specifies the name of a program pipeline object from which to retrieve the info log.
bufSize
Specifies the maximum number of characters, including the null terminator, that may be written into infoLog​.
length
Specifies the address of a variable into which will be written the number of characters written into infoLog​.
infoLog
Specifies the address of an array of characters into which will be written the info log for pipeline​.

Description

glGetProgramPipelineInfoLog retrieves the info log for the program pipeline object pipeline​. The info log, including its null terminator, is written into the array of characters whose address is given by infoLog​. The maximum number of characters that may be written into infoLog​ is given by bufSize​, and the actual number of characters written into infoLog​ is returned in the integer whose address is given by length​. If length​ is NULL, no length is returned.

The actual length of the info log for the program pipeline may be determined by calling glGetProgramPipeline with pname​ set to GL_INFO_LOG_LENGTH.

Errors

GL_INVALID_OPERATION is generated if pipeline​ is not a name previously returned from a call to glGenProgramPipelines or if such a name has been deleted by a call to glDeleteProgramPipelines.

Associated Gets

glGetProgramPipeline with parameter GL_INFO_LOG_LENGTH.

See Also

glGenProgramPipelines, glBindProgramPipeline, glDeleteProgramPipelines, glGetProgramPipeline

Copyright

Copyright © 2010 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/.