Opentk/Source/Bind/Specifications/Docs/glGetProgramPipelineInfoLog.xml
2010-12-04 21:51:40 +00:00

115 lines
5.6 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glGetProgramPipelineInfoLog">
<refmeta>
<refmetainfo>
<copyright>
<year>2010</year>
<holder>Khronos Group</holder>
</copyright>
</refmetainfo>
<refentrytitle>glGetProgramPipelineInfoLog</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetProgramPipelineInfoLog</refname>
<refpurpose>retrieve the info log string from a program pipeline object</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetProgramPipelineInfoLog</function></funcdef>
<paramdef>GLuint <parameter>pipeline</parameter></paramdef>
<paramdef>GLsizei <parameter>bufSize</parameter></paramdef>
<paramdef>GLsizei *<parameter>length</parameter></paramdef>
<paramdef>GLchar *<parameter>infoLog</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>pipeline</parameter></term>
<listitem>
<para>
Specifies the name of a program pipeline object from which to retrieve the info log.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bufSize</parameter></term>
<listitem>
<para>
Specifies the maximum number of characters, including the null terminator, that may be written into <parameter>infoLog</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
Specifies the address of a variable into which will be written the number of characters written into <parameter>infoLog</parameter>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>infoLog</parameter></term>
<listitem>
<para>
Specifies the address of an array of characters into which will be written the info log for <parameter>pipeline</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glGetProgramPipelineInfoLog</function> retrieves the info log for the program
pipeline object <parameter>pipeline</parameter>. The info log, including its null terminator,
is written into the array of characters whose address is given by <parameter>infoLog</parameter>.
The maximum number of characters that may be written into <parameter>infoLog</parameter>
is given by <parameter>bufSize</parameter>, and the actual number of characters written
into <parameter>infoLog</parameter> is returned in the integer whose address is given
by <parameter>length</parameter>. If <parameter>length</parameter> is <constant>NULL</constant>,
no length is returned.
</para>
<para>
The actual length of the info log for the program pipeline may be determined by calling
<citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry> with
<parameter>pname</parameter> set to <constant>GL_INFO_LOG_LENGTH</constant>.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>pipeline</parameter> is not
a name previously returned from a call to <citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>
or if such a name has been deleted by a call to
<citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry>
with parameter <constant>GL_INFO_LOG_LENGTH</constant>.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glGenProgramPipelines</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glBindProgramPipeline</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glDeleteProgramPipelines</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGetProgramPipeline</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 2010 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.
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
</para>
</refsect1>
</refentry>