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>glGetProgramInfoLog
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.73.2" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glGetProgramInfoLog"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetProgramInfoLog — Returns the information log for a program 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">glGetProgramInfoLog
</b>(
</code></td><td>GLuint
</td><td><var class=
"pdparam">program
</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>program
</code></em></span></dt><dd><p>Specifies the program 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">glGetProgramInfoLog
</code> returns the
9 information log for the specified program object. The
10 information log for a program object is modified when the
11 program object is linked or validated. The string that is
12 returned will be null terminated.
</p><p><code class=
"function">glGetProgramInfoLog
</code> returns in
13 <em class=
"parameter"><code>infoLog
</code></em> as much of the information log as
14 it can, up to a maximum of
<em class=
"parameter"><code>maxLength
</code></em>
15 characters. The number of characters actually returned,
16 excluding the null termination character, is specified by
17 <em class=
"parameter"><code>length
</code></em>. If the length of the returned
18 string is not required, a value of
<code class=
"constant">NULL
</code> can
19 be passed in the
<em class=
"parameter"><code>length
</code></em> argument. The
20 size of the buffer required to store the returned information
21 log can be obtained by calling
22 <a class=
"citerefentry" href=
"glGetProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetProgram
</span></span></a>
23 with the value
<code class=
"constant">GL_INFO_LOG_LENGTH
</code>.
</p><p>The information log for a program object is either an
24 empty string, or a string containing information about the last
25 link operation, or a string containing information about the
26 last validation operation. It may contain diagnostic messages,
27 warning messages, and other information. When a program object
28 is created, its information log will be a string of length
29 0.
</p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p><code class=
"function">glGetProgramInfoLog
</code> is available only
30 if the GL version is
2.0 or greater.
</p><p>The information log for a program object is the OpenGL
31 implementer's primary mechanism for conveying information about
32 linking and validating. Therefore, the information log can be
33 helpful to application developers during the development
34 process, even when these operations are successful. Application
35 developers should not expect different OpenGL implementations to
36 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
37 <em class=
"parameter"><code>program
</code></em> is not a value generated by
38 OpenGL.
</p><p><code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
39 <em class=
"parameter"><code>program
</code></em> is not a program object.
</p><p><code class=
"constant">GL_INVALID_VALUE
</code> is generated if
40 <em class=
"parameter"><code>maxLength
</code></em> is less than
0.
</p><p><code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
41 <code class=
"function">glGetProgramInfoLog
</code> is executed between the
43 <a class=
"citerefentry" href=
"glBegin.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBegin
</span></span></a>
44 and the corresponding execution of
45 <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=
"glGetProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetProgram
</span></span></a>
46 with argument
<code class=
"constant">GL_INFO_LOG_LENGTH
</code></p><p><a class=
"citerefentry" href=
"glIsProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIsProgram
</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>,
47 <a class=
"citerefentry" href=
"glGetShaderInfoLog.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetShaderInfoLog
</span></span></a>,
48 <a class=
"citerefentry" href=
"glLinkProgram.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glLinkProgram
</span></span></a>,
49 <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>
50 Copyright
<span class=
"trademark"></span>©
2003-
2005 3Dlabs Inc. Ltd.
51 This material may be distributed subject to the terms and conditions set forth in
52 the Open Publication License, v
1.0,
8 June
1999.
53 <a class=
"ulink" href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
54 </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blob