HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
| 2 | <!-- saved from url=(0013)about:internet --> | |
| 3 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glGetShaderInfoLog</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetShaderInfoLog"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetShaderInfoLog — Returns the information log for a shader object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetShaderInfoLog</b>(</code></td><td>GLuint </td><td><var class="pdparam">shader</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">maxLength</var>, </td></tr><tr><td> </td><td>GLsizei * </td><td><var class="pdparam">length</var>, </td></tr><tr><td> </td><td>GLchar * </td><td><var class="pdparam">infoLog</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>shader</code></em></span></dt><dd><p>Specifies the shader object whose information | |
| 4 | 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 | |
| 5 | 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 | |
| 6 | <em class="parameter"><code>infoLog</code></em> (excluding the null | |
| 7 | 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 | |
| 8 | to return the information log.</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p><code class="function">glGetShaderInfoLog</code> returns the | |
| 9 | information log for the specified shader object. The information | |
| 10 | log for a shader object is modified when the shader is compiled. | |
| 11 | The string that is returned will be null terminated.</p><p><code class="function">glGetShaderInfoLog</code> returns in | |
| 12 | <em class="parameter"><code>infoLog</code></em> as much of the information log as | |
| 13 | it can, up to a maximum of <em class="parameter"><code>maxLength</code></em> | |
| 14 | characters. The number of characters actually returned, | |
| 15 | excluding the null termination character, is specified by | |
| 16 | <em class="parameter"><code>length</code></em>. If the length of the returned | |
| 17 | string is not required, a value of <code class="constant">NULL</code> can | |
| 18 | be passed in the <em class="parameter"><code>length</code></em> argument. The | |
| 19 | size of the buffer required to store the returned information | |
| 20 | log can be obtained by calling | |
| 21 | <a class="citerefentry" href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a> | |
| 22 | with the value <code class="constant">GL_INFO_LOG_LENGTH</code>.</p><p>The information log for a shader object is a string that | |
| 23 | may contain diagnostic messages, warning messages, and other | |
| 24 | information about the last compile operation. When a shader | |
| 25 | object is created, its information log will be a string of | |
| 26 | length 0.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p><code class="function">glGetShaderInfoLog</code> is available only | |
| 27 | if the GL version is 2.0 or greater.</p><p>The information log for a shader object is the OpenGL | |
| 28 | implementer's primary mechanism for conveying information about | |
| 29 | the compilation process. Therefore, the information log can be | |
| 30 | helpful to application developers during the development | |
| 31 | process, even when compilation is successful. Application | |
| 32 | developers should not expect different OpenGL implementations to | |
| 33 | produce identical information logs.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p><code class="constant">GL_INVALID_VALUE</code> is generated if | |
| 34 | <em class="parameter"><code>shader</code></em> is not a value generated by | |
| 35 | OpenGL.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if | |
| 36 | <em class="parameter"><code>shader</code></em> is not a shader object.</p><p><code class="constant">GL_INVALID_VALUE</code> is generated if | |
| 37 | <em class="parameter"><code>maxLength</code></em> is less than 0.</p><p><code class="constant">GL_INVALID_OPERATION</code> is generated if | |
| 38 | <code class="function">glGetShaderInfoLog</code> is executed between the | |
| 39 | execution of | |
| 40 | <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> | |
| 41 | and the corresponding execution of | |
| 42 | <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a class="citerefentry" href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a> | |
| 43 | with argument <code class="constant">GL_INFO_LOG_LENGTH</code></p><p><a class="citerefentry" href="glIsShader.xml"><span class="citerefentry"><span class="refentrytitle">glIsShader</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p><a class="citerefentry" href="glCompileShader.xml"><span class="citerefentry"><span class="refentrytitle">glCompileShader</span></span></a>, | |
| 44 | <a class="citerefentry" href="glGetProgramInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramInfoLog</span></span></a>, | |
| 45 | <a class="citerefentry" href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>, | |
| 46 | <a class="citerefentry" href="glValidateProgram.xml"><span class="citerefentry"><span class="refentrytitle">glValidateProgram</span></span></a></p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 47 | Copyright <span class="trademark"></span>© 2003-2005 3Dlabs Inc. Ltd. | |
| 48 | This material may be distributed subject to the terms and conditions set forth in | |
| 49 | the Open Publication License, v 1.0, 8 June 1999. | |
| 50 | <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 51 | </p></div></div></body></html> |