File: glGetProgramPipelineInfoLog.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn27841-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 24,888 kB
  • ctags: 377
  • sloc: xml: 188,408; makefile: 1,153; python: 736; sh: 49; php: 7; sed: 2
file content (42 lines) | stat: -rw-r--r-- 6,213 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<?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.78.1" /></head><body><div class="refentry"><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" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetProgramPipelineInfoLog</strong>(</code></td><td>GLuint <var class="pdparam">pipeline</var>, </td></tr><tr><td> </td><td>GLsizei <var class="pdparam">bufSize</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>pipeline</code></em></span></dt><dd><p>
                Specifies the name of a program pipeline object from which to retrieve the info log.
            </p></dd><dt><span class="term"><em class="parameter"><code>bufSize</code></em></span></dt><dd><p>
                Specifies the maximum number of characters, including the null terminator, that may be written into <em class="parameter"><code>infoLog</code></em>.
            </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
                Specifies the address of a variable into which will be written the number of characters written into <em class="parameter"><code>infoLog</code></em>.
            </p></dd><dt><span class="term"><em class="parameter"><code>infoLog</code></em></span></dt><dd><p>
                Specifies the address of an array of characters into which will be written the info log for <em class="parameter"><code>pipeline</code></em>.
            </p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
            <code class="function">glGetProgramPipelineInfoLog</code> retrieves the info log for the program
            pipeline object <em class="parameter"><code>pipeline</code></em>. The info log, including its null terminator,
            is written into the array of characters whose address is given by <em class="parameter"><code>infoLog</code></em>.
            The maximum number of characters that may be written into <em class="parameter"><code>infoLog</code></em>
            is given by <em class="parameter"><code>bufSize</code></em>, and the actual number of characters written
            into <em class="parameter"><code>infoLog</code></em> is returned in the integer whose address is given
            by <em class="parameter"><code>length</code></em>. If <em class="parameter"><code>length</code></em> is <code class="constant">NULL</code>,
            no length is returned.
        </p><p>
            The actual length of the info log for the program pipeline may be determined by calling
            <a class="citerefentry" href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a> with
            <em class="parameter"><code>pname</code></em> set to <code class="constant">GL_INFO_LOG_LENGTH</code>.
        </p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
            <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>pipeline</code></em> is not
            a name previously returned from a call to <a class="citerefentry" href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>
            or if such a name has been deleted by a call to
            <a class="citerefentry" href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>.
        </p></div><div class="refsect1"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
            <a class="citerefentry" href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a>
            with parameter <code class="constant">GL_INFO_LOG_LENGTH</code>.
        </p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
            <a class="citerefentry" href="glGenProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glGenProgramPipelines</span></span></a>,
            <a class="citerefentry" href="glBindProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glBindProgramPipeline</span></span></a>,
            <a class="citerefentry" href="glDeleteProgramPipelines.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteProgramPipelines</span></span></a>,
            <a class="citerefentry" href="glGetProgramPipeline.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramPipeline</span></span></a>
        </p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
            Copyright <span class="trademark"></span>© 2010-2013 Khronos Group.
            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="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p></div></div></body></html>