Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
3 | <!-- saved from url=(0013)about:internet --> | |
4 | <?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>glGetProgramPipelineInfoLog - 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="glGetProgramPipelineInfoLog"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetProgramPipelineInfoLog — retrieve the info log string from a program pipeline 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">glGetProgramPipelineInfoLog</b>(</code></td><td>GLuint </td><td><var class="pdparam">pipeline</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">bufSize</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>pipeline</code></em></span></dt><dd><p> | |
5 | Specifies the name of a program pipeline object from which to retrieve the info log. | |
6 | </p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p> | |
7 | Specifies the maximum number of characters, including the null terminator, that may be written into <em class="parameter"><code>infoLog</code></em>. | |
8 | </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p> | |
9 | Specifies the address of a variable into which will be written the number of characters written into <em class="parameter"><code>infoLog</code></em>. | |
10 | </p></dd><dt><span class="term"><em class="parameter"><code>infoLog</code></em></span></dt><dd><p> | |
11 | Specifies the address of an array of characters into which will be written the info log for <em class="parameter"><code>pipeline</code></em>. | |
12 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
13 | <code class="function">glGetProgramPipelineInfoLog</code> retrieves the info log for the program | |
14 | pipeline object <em class="parameter"><code>pipeline</code></em>. The info log, including its null terminator, | |
15 | is written into the array of characters whose address is given by <em class="parameter"><code>infoLog</code></em>. | |
16 | The maximum number of characters that may be written into <em class="parameter"><code>infoLog</code></em> | |
17 | is given by <em class="parameter"><code>bufSize</code></em>, and the actual number of characters written | |
18 | into <em class="parameter"><code>infoLog</code></em> is returned in the integer whose address is given | |
19 | by <em class="parameter"><code>length</code></em>. If <em class="parameter"><code>length</code></em> is <code class="constant">NULL</code>, | |
20 | no length is returned. | |
21 | </p><p> | |
22 | The actual length of the info log for the program pipeline may be determined by calling | |
23 | <a href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a> with | |
24 | <em class="parameter"><code>pname</code></em> set to <code class="constant">GL_INFO_LOG_LENGTH</code>. | |
25 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
26 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pipeline</code></em> is not | |
27 | a name previously returned from a call to <a href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a> | |
28 | or if such a name has been deleted by a call to | |
29 | <a href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>. | |
30 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
31 | <a href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a> | |
32 | with parameter <code class="constant">GL_INFO_LOG_LENGTH</code>. | |
33 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
34 | <a href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>, | |
35 | <a href="glBindProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glBindProgramPipeline</span></span></a>, | |
36 | <a href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>, | |
37 | <a href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a> | |
38 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
39 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
40 | This material may be distributed subject to the terms and conditions set forth in | |
41 | the Open Publication License, v 1.0, 8 June 1999. | |
42 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
43 | </p></div></div></body></html> |