mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-25 16:25:37 +00:00
127 lines
5.4 KiB
XML
127 lines
5.4 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="glGetProgramInfoLog">
|
|
<refmeta>
|
|
<refentrytitle>glGetProgramInfoLog</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glGetProgramInfoLog</refname>
|
|
<refpurpose>Returns the information log for a program object</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glGetProgramInfoLog</function></funcdef>
|
|
<paramdef>GLuint <parameter>program</parameter></paramdef>
|
|
<paramdef>GLsizei <parameter>maxLength</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>program</parameter></term>
|
|
<listitem>
|
|
<para>Specifies the program object whose information
|
|
log is to be queried.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>maxLength</parameter></term>
|
|
<listitem>
|
|
<para>Specifies the size of the character buffer for
|
|
storing the returned information log.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>length</parameter></term>
|
|
<listitem>
|
|
<para>Returns the length of the string returned in
|
|
<parameter>infoLog</parameter> (excluding the null
|
|
terminator).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>infoLog</parameter></term>
|
|
<listitem>
|
|
<para>Specifies an array of characters that is used
|
|
to return the information log.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para><function>glGetProgramInfoLog</function> returns the
|
|
information log for the specified program object. The
|
|
information log for a program object is modified when the
|
|
program object is linked or validated. The string that is
|
|
returned will be null terminated.</para>
|
|
|
|
<para><function>glGetProgramInfoLog</function> returns in
|
|
<parameter>infoLog</parameter> as much of the information log as
|
|
it can, up to a maximum of <parameter>maxLength</parameter>
|
|
characters. The number of characters actually returned,
|
|
excluding the null termination character, is specified by
|
|
<parameter>length</parameter>. If the length of the returned
|
|
string is not required, a value of <constant>NULL</constant> can
|
|
be passed in the <parameter>length</parameter> argument. The
|
|
size of the buffer required to store the returned information
|
|
log can be obtained by calling
|
|
<citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
|
|
with the value <constant>GL_INFO_LOG_LENGTH</constant>. </para>
|
|
|
|
<para>The information log for a program object is either an
|
|
empty string, or a string containing information about the last
|
|
link operation, or a string containing information about the
|
|
last validation operation. It may contain diagnostic messages,
|
|
warning messages, and other information. When a program object
|
|
is created, its information log will be a string of length
|
|
0.</para>
|
|
</refsect1>
|
|
<refsect1 id="notes"><title>Notes</title>
|
|
<para>The information log for a program object is the OpenGL
|
|
implementer's primary mechanism for conveying information about
|
|
linking and validating. Therefore, the information log can be
|
|
helpful to application developers during the development
|
|
process, even when these operations are successful. Application
|
|
developers should not expect different OpenGL implementations to
|
|
produce identical information logs.</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para><constant>GL_INVALID_VALUE</constant> is generated if
|
|
<parameter>program</parameter> is not a value generated by
|
|
OpenGL.</para>
|
|
|
|
<para><constant>GL_INVALID_OPERATION</constant> is generated if
|
|
<parameter>program</parameter> is not a program object.</para>
|
|
|
|
<para><constant>GL_INVALID_VALUE</constant> is generated if
|
|
<parameter>maxLength</parameter> is less than 0.</para>
|
|
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para><citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>
|
|
with argument <constant>GL_INFO_LOG_LENGTH</constant></para>
|
|
|
|
<para><citerefentry><refentrytitle>glIsProgram</refentrytitle></citerefentry></para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para><citerefentry><refentrytitle>glCompileShader</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glValidateProgram</refentrytitle></citerefentry></para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
|
|
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>
|