<div class="refentry"><a id="glGetShaderInfoLog"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetShaderInfoLog — return the information log for a shader object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetShaderInfoLog</strong>(</code></td><td>GLuint <var class="pdparam">shader</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">maxLength</var>, </td></tr><tr><td> </td><td>GLsizei *<var class="pdparam">length</var>, </td></tr><tr><td> </td><td>GLchar *<var class="pdparam">infoLog</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>shader</code></em></span></dt><dd><p>Specifies the shader object whose information

log is to be queried.</p></dd><dt><span class="term"><em class="parameter"><code>maxLength</code></em></span></dt><dd><p>Specifies the size of the character buffer for

storing the returned information log.</p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>Returns the length of the string returned in

<em class="parameter"><code>infoLog</code></em> (excluding the null

terminator).</p></dd><dt><span class="term"><em class="parameter"><code>infoLog</code></em></span></dt><dd><p>Specifies an array of characters that is used

to return the information log.</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p><code class="function">glGetShaderInfoLog</code> 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.</p><p><code class="function">glGetShaderInfoLog</code> returns in

<em class="parameter"><code>infoLog</code></em> as much of the information log as

it can, up to a maximum of <em class="parameter"><code>maxLength</code></em>

characters. The number of characters actually returned,

excluding the null termination character, is specified by

<em class="parameter"><code>length</code></em>. If the length of the returned

string is not required, a value of <code class="constant">NULL</code> can

be passed in the <em class="parameter"><code>length</code></em> argument. The

size of the buffer required to store the returned information

log can be obtained by calling

<a class="citerefentry" href="glGetShaderiv"><span class="citerefentry"><span class="refentrytitle">glGetShaderiv</span></span></a>

with the value <code class="constant">GL_INFO_LOG_LENGTH</code>.</p><p>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.</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>The information log for a shader object is the OpenGL

implementer's 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.</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if

<em class="parameter"><code>shader</code></em> is not a value generated by

OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if

<em class="parameter"><code>shader</code></em> is not a shader object.</p><p><code class="constant">GL_INVALID_VALUE</code> is generated if

<em class="parameter"><code>maxLength</code></em> is less than 0.</p></div><div class="refsect1"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a class="citerefentry" href="glGetShaderiv"><span class="citerefentry"><span class="refentrytitle">glGetShaderiv</span></span></a>

with argument <code class="constant">GL_INFO_LOG_LENGTH</code></p><p><a class="citerefentry" href="glIsShader"><span class="citerefentry"><span class="refentrytitle">glIsShader</span></span></a></p></div>

{$pipelinestall}{$examples}

<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p><a class="citerefentry" href="glCompileShader"><span class="citerefentry"><span class="refentrytitle">glCompileShader</span></span></a>,

<a class="citerefentry" href="glGetProgramInfoLog"><span class="citerefentry"><span class="refentrytitle">glGetProgramInfoLog</span></span></a>,

<a class="citerefentry" href="glLinkProgram"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>,

<a class="citerefentry" href="glValidateProgram"><span class="citerefentry"><span class="refentrytitle">glValidateProgram</span></span></a></p></div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>

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.

<a class="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.

</p></div></div></div>