'\" t .\" Title: glGetShaderInfoLog .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 .\" Date: 05/21/2015 .\" Manual: [FIXME: manual] .\" Source: [FIXME: source] .\" Language: English .\" .TH "GLGETSHADERINFOLOG" "3G" "05/21/2015" "[FIXME: source]" "[FIXME: manual]" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" glGetShaderInfoLog \- Returns the information log for a shader object .SH "C SPECIFICATION" .HP \w'void\ glGetShaderInfoLog('u .BI "void glGetShaderInfoLog(GLuint\ " "shader" ", GLsizei\ " "maxLength" ", GLsizei\ *" "length" ", GLchar\ *" "infoLog" ");" .SH "PARAMETERS" .PP \fIshader\fR .RS 4 Specifies the shader object whose information log is to be queried\&. .RE .PP \fImaxLength\fR .RS 4 Specifies the size of the character buffer for storing the returned information log\&. .RE .PP \fIlength\fR .RS 4 Returns the length of the string returned in \fIinfoLog\fR (excluding the null terminator)\&. .RE .PP \fIinfoLog\fR .RS 4 Specifies an array of characters that is used to return the information log\&. .RE .SH "DESCRIPTION" .PP \fBglGetShaderInfoLog\fR returns the information log for the specified shader object\&. The information log for a shader object is modified when the shader is compiled\&. The string that is returned will be null terminated\&. .PP \fBglGetShaderInfoLog\fR returns in \fIinfoLog\fR as much of the information log as it can, up to a maximum of \fImaxLength\fR characters\&. The number of characters actually returned, excluding the null termination character, is specified by \fIlength\fR\&. If the length of the returned string is not required, a value of \fBNULL\fR can be passed in the \fIlength\fR argument\&. The size of the buffer required to store the returned information log can be obtained by calling \fBglGetShader\fR() with the value \fBGL_INFO_LOG_LENGTH\fR\&. .PP The information log for a shader object is a string that may contain diagnostic messages, warning messages, and other information about the last compile operation\&. When a shader object is created, its information log will be a string of length 0\&. .SH "NOTES" .PP The information log for a shader object is the OpenGL implementer\*(Aqs primary mechanism for conveying information about the compilation process\&. Therefore, the information log can be helpful to application developers during the development process, even when compilation is successful\&. Application developers should not expect different OpenGL implementations to produce identical information logs\&. .SH "ERRORS" .PP \fBGL_INVALID_VALUE\fR is generated if \fIshader\fR is not a value generated by OpenGL\&. .PP \fBGL_INVALID_OPERATION\fR is generated if \fIshader\fR is not a shader object\&. .PP \fBGL_INVALID_VALUE\fR is generated if \fImaxLength\fR is less than 0\&. .SH "ASSOCIATED GETS" .PP \fBglGetShader\fR() with argument \fBGL_INFO_LOG_LENGTH\fR .PP \fBglIsShader\fR() .SH "VERSION SUPPORT" .TS allbox tab(:); lB cB s s s s s s s s s s s lB cB cB cB cB cB cB cB cB cB cB cB cB. T{ T}:T{ \fBOpenGL Version\fR T} T{ \fBFunction / Feature Name\fR T}:T{ \fB2\&.0\fR T}:T{ \fB2\&.1\fR T}:T{ \fB3\&.0\fR T}:T{ \fB3\&.1\fR T}:T{ \fB3\&.2\fR T}:T{ \fB3\&.3\fR T}:T{ \fB4\&.0\fR T}:T{ \fB4\&.1\fR T}:T{ \fB4\&.2\fR T}:T{ \fB4\&.3\fR T}:T{ \fB4\&.4\fR T}:T{ \fB4\&.5\fR T} .T& l c c c c c c c c c c c c. T{ \fBglGetShaderInfoLog\fR T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T}:T{ ✔ T} .TE .sp .SH "SEE ALSO" .PP \fBglCompileShader\fR(), \fBglGetProgramInfoLog\fR(), \fBglLinkProgram\fR(), \fBglValidateProgram\fR() .SH "COPYRIGHT" .PP Copyright \(co 2003\-2005 3Dlabs Inc\&. Ltd\&. Copyright \(co 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\&. \m[blue]\fBhttp://opencontent\&.org/openpub/\fR\m[]\&. .SH "COPYRIGHT" .br Copyright \(co 2003-2005 3Dlabs Inc. Ltd. .br Copyright \(co 2010-2014 Khronos Group .br