upstream-man-pages/man4/glGetProgramPipelineInfoLog.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glGetProgramPipelineInfoLog">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetProgramPipelineInfoLog</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetProgramPipelineInfoLog</refname>
  17         <refpurpose>retrieve the info log string from a program pipeline object</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGetProgramPipelineInfoLog</function></funcdef>
  23                 <paramdef>GLuint <parameter>pipeline</parameter></paramdef>
  24                 <paramdef>GLsizei <parameter>bufSize</parameter></paramdef>
  25                 <paramdef>GLsizei *<parameter>length</parameter></paramdef>
  26                 <paramdef>GLchar *<parameter>infoLog</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <refsect1 id="parameters"><title>Parameters</title>
  31         <variablelist>
  32         <varlistentry>
  33             <term><parameter>pipeline</parameter></term>
  34             <listitem>
  35             <para>
  36                 Specifies the name of a program pipeline object from which to retrieve the info log.
  37             </para>
  38             </listitem>
  39         </varlistentry>
  40         <varlistentry>
  41             <term><parameter>bufSize</parameter></term>
  42             <listitem>
  43             <para>
  44                 Specifies the maximum number of characters, including the null terminator, that may be written into <parameter>infoLog</parameter>.
  45             </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>length</parameter></term>
  50             <listitem>
  51             <para>
  52                 Specifies the address of a variable into which will be written the number of characters written into <parameter>infoLog</parameter>.
  53             </para>
  54             </listitem>
  55         </varlistentry>
  56         <varlistentry>
  57             <term><parameter>infoLog</parameter></term>
  58             <listitem>
  59             <para>
  60                 Specifies the address of an array of characters into which will be written the info log for <parameter>pipeline</parameter>.
  61             </para>
  62             </listitem>
  63         </varlistentry>
  64         </variablelist>
  65     </refsect1>
  66     <refsect1 id="description"><title>Description</title>
  67         <para>
  68             <function>glGetProgramPipelineInfoLog</function> retrieves the info log for the program
  69             pipeline object <parameter>pipeline</parameter>. The info log, including its null terminator,
  70             is written into the array of characters whose address is given by <parameter>infoLog</parameter>.
  71             The maximum number of characters that may be written into <parameter>infoLog</parameter>
  72             is given by <parameter>bufSize</parameter>, and the actual number of characters written
  73             into <parameter>infoLog</parameter> is returned in the integer whose address is given
  74             by <parameter>length</parameter>. If <parameter>length</parameter> is <constant>NULL</constant>,
  75             no length is returned.
  76         </para>
  77         <para>
  78             The actual length of the info log for the program pipeline may be determined by calling
  79             <citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry> with
  80             <parameter>pname</parameter> set to <constant>GL_INFO_LOG_LENGTH</constant>.
  81         </para>
  82     </refsect1>
  83     <refsect1 id="errors"><title>Errors</title>
  84         <para>
  85             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>pipeline</parameter> is not
  86             a name previously returned from a call to <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>
  87             or if such a name has been deleted by a call to
  88             <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>.
  89         </para>
  90     </refsect1>
  91     <refsect1 id="associatedgets"><title>Associated Gets</title>
  92         <para>
  93             <citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry>
  94             with parameter <constant>GL_INFO_LOG_LENGTH</constant>.
  95         </para>
  96     </refsect1>
  97
  98     <refsect1 id="seealso"><title>See Also</title>
  99         <para>
 100             <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
 101             <citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
 102             <citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>,
 103             <citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry>
 104         </para>
 105     </refsect1>
 106     <refsect1 id="Copyright"><title>Copyright</title>
 107         <para>
 108             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
 109             This material may be distributed subject to the terms and conditions set forth in
 110             the Open Publication License, v 1.0, 8 June 1999.
 111             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 112         </para>
 113     </refsect1>
 114 </refentry>