rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glGetShaderInfoLog.xml
diff --git a/upstream-doc/man4/xhtml/glGetShaderInfoLog.xml b/upstream-doc/man4/xhtml/glGetShaderInfoLog.xml
new file mode 100644 (file)
index 0000000..c6fabc2
--- /dev/null
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
+<!-- saved from url=(0013)about:internet -->
+<?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetShaderInfoLog - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></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
+                   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" lang="en" xml:lang="en"><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 href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</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" lang="en" xml:lang="en"><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" lang="en" xml:lang="en"><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" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p><a href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a>
+       with argument <code class="constant">GL_INFO_LOG_LENGTH</code></p><p><a 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 href="glCompileShader.xml"><span class="citerefentry"><span class="refentrytitle">glCompileShader</span></span></a>,
+       <a href="glGetProgramInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramInfoLog</span></span></a>,
+       <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>,
+       <a 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>
+            Copyright <span class="trademark"></span>© 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 href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
+        </p></div></div></body></html>