Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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="glGetProgramInfoLog"> | |
5 | <refmeta> | |
6 | <refentrytitle>glGetProgramInfoLog</refentrytitle> | |
7 | <manvolnum>3G</manvolnum> | |
8 | </refmeta> | |
9 | <refnamediv> | |
10 | <refname>glGetProgramInfoLog</refname> | |
11 | <refpurpose>Returns the information log for a program object</refpurpose> | |
12 | </refnamediv> | |
13 | <refsynopsisdiv><title>C Specification</title> | |
14 | <funcsynopsis> | |
15 | <funcprototype> | |
16 | <funcdef>void <function>glGetProgramInfoLog</function></funcdef> | |
17 | <paramdef>GLuint <parameter>program</parameter></paramdef> | |
18 | <paramdef>GLsizei <parameter>maxLength</parameter></paramdef> | |
19 | <paramdef>GLsizei *<parameter>length</parameter></paramdef> | |
20 | <paramdef>GLchar *<parameter>infoLog</parameter></paramdef> | |
21 | </funcprototype> | |
22 | </funcsynopsis> | |
23 | </refsynopsisdiv> | |
24 | <refsect1 id="parameters"><title>Parameters</title> | |
25 | <variablelist> | |
26 | <varlistentry> | |
27 | <term><parameter>program</parameter></term> | |
28 | <listitem> | |
29 | <para>Specifies the program object whose information | |
30 | log is to be queried.</para> | |
31 | </listitem> | |
32 | </varlistentry> | |
33 | <varlistentry> | |
34 | <term><parameter>maxLength</parameter></term> | |
35 | <listitem> | |
36 | <para>Specifies the size of the character buffer for | |
37 | storing the returned information log.</para> | |
38 | </listitem> | |
39 | </varlistentry> | |
40 | <varlistentry> | |
41 | <term><parameter>length</parameter></term> | |
42 | <listitem> | |
43 | <para>Returns the length of the string returned in | |
44 | <parameter>infoLog</parameter> (excluding the null | |
45 | terminator).</para> | |
46 | </listitem> | |
47 | </varlistentry> | |
48 | <varlistentry> | |
49 | <term><parameter>infoLog</parameter></term> | |
50 | <listitem> | |
51 | <para>Specifies an array of characters that is used | |
52 | to return the information log.</para> | |
53 | </listitem> | |
54 | </varlistentry> | |
55 | </variablelist> | |
56 | </refsect1> | |
57 | <refsect1 id="description"><title>Description</title> | |
58 | <para><function>glGetProgramInfoLog</function> returns the | |
59 | information log for the specified program object. The | |
60 | information log for a program object is modified when the | |
61 | program object is linked or validated. The string that is | |
62 | returned will be null terminated.</para> | |
63 | ||
64 | <para><function>glGetProgramInfoLog</function> returns in | |
65 | <parameter>infoLog</parameter> as much of the information log as | |
66 | it can, up to a maximum of <parameter>maxLength</parameter> | |
67 | characters. The number of characters actually returned, | |
68 | excluding the null termination character, is specified by | |
69 | <parameter>length</parameter>. If the length of the returned | |
70 | string is not required, a value of <constant>NULL</constant> can | |
71 | be passed in the <parameter>length</parameter> argument. The | |
72 | size of the buffer required to store the returned information | |
73 | log can be obtained by calling | |
74 | <citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry> | |
75 | with the value <constant>GL_INFO_LOG_LENGTH</constant>. </para> | |
76 | ||
77 | <para>The information log for a program object is either an | |
78 | empty string, or a string containing information about the last | |
79 | link operation, or a string containing information about the | |
80 | last validation operation. It may contain diagnostic messages, | |
81 | warning messages, and other information. When a program object | |
82 | is created, its information log will be a string of length | |
83 | 0.</para> | |
84 | </refsect1> | |
85 | <refsect1 id="notes"><title>Notes</title> | |
86 | <para>The information log for a program object is the OpenGL | |
87 | implementer's primary mechanism for conveying information about | |
88 | linking and validating. Therefore, the information log can be | |
89 | helpful to application developers during the development | |
90 | process, even when these operations are successful. Application | |
91 | developers should not expect different OpenGL implementations to | |
92 | produce identical information logs.</para> | |
93 | </refsect1> | |
94 | <refsect1 id="errors"><title>Errors</title> | |
95 | <para><constant>GL_INVALID_VALUE</constant> is generated if | |
96 | <parameter>program</parameter> is not a value generated by | |
97 | OpenGL.</para> | |
98 | ||
99 | <para><constant>GL_INVALID_OPERATION</constant> is generated if | |
100 | <parameter>program</parameter> is not a program object.</para> | |
101 | ||
102 | <para><constant>GL_INVALID_VALUE</constant> is generated if | |
103 | <parameter>maxLength</parameter> is less than 0.</para> | |
104 | ||
105 | </refsect1> | |
106 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
107 | <para><citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry> | |
108 | with argument <constant>GL_INFO_LOG_LENGTH</constant></para> | |
109 | ||
110 | <para><citerefentry><refentrytitle>glIsProgram</refentrytitle></citerefentry></para> | |
111 | </refsect1> | |
112 | <refsect1 id="seealso"><title>See Also</title> | |
113 | <para><citerefentry><refentrytitle>glCompileShader</refentrytitle></citerefentry>, | |
114 | <citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>, | |
115 | <citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>, | |
116 | <citerefentry><refentrytitle>glValidateProgram</refentrytitle></citerefentry></para> | |
117 | </refsect1> | |
118 | <refsect1 id="Copyright"><title>Copyright</title> | |
119 | <para> | |
120 | Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd. | |
121 | This material may be distributed subject to the terms and conditions set forth in | |
122 | the Open Publication License, v 1.0, 8 June 1999. | |
123 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
124 | </para> | |
125 | </refsect1> | |
126 | </refentry> |