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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glGetError">
<info>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glGetError</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glGetError</refname>
<refpurpose>return error information</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLenum <function>glGetError</function></funcdef>
<paramdef> <parameter>void</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="description"><title>Description</title>
<para>
<function>glGetError</function> returns the value of the error flag.
Each detectable error is assigned a numeric code and symbolic name.
When an error occurs,
the error flag is set to the appropriate error code value.
No other errors are recorded until <function>glGetError</function> is called,
the error code is returned,
and the flag is reset to <constant>GL_NO_ERROR</constant>.
If a call to <function>glGetError</function> returns <constant>GL_NO_ERROR</constant>,
there has been no detectable error since the last call to <function>glGetError</function>,
or since the GL was initialized.
</para>
<para>
To allow for distributed implementations,
there may be several error flags.
If any single error flag has recorded an error,
the value of that flag is returned
and that flag is reset to <constant>GL_NO_ERROR</constant>
when <function>glGetError</function> is called.
If more than one flag has recorded an error,
<function>glGetError</function> returns and clears an arbitrary error flag value.
Thus, <function>glGetError</function> should always be called in a loop,
until it returns <constant>GL_NO_ERROR</constant>,
if all error flags are to be reset.
</para>
<para>
Initially, all error flags are set to <constant>GL_NO_ERROR</constant>.
</para>
<para>
The following errors are currently defined:
</para>
<variablelist>
<varlistentry>
<term><constant>GL_NO_ERROR</constant></term>
<listitem>
<para>
No error has been recorded.
The value of this symbolic constant is guaranteed to be 0.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_INVALID_ENUM</constant></term>
<listitem>
<para>
An unacceptable value is specified for an enumerated argument.
The offending command is ignored
and has no other side effect than to set the error flag.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_INVALID_VALUE</constant></term>
<listitem>
<para>
A numeric argument is out of range.
The offending command is ignored
and has no other side effect than to set the error flag.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_INVALID_OPERATION</constant></term>
<listitem>
<para>
The specified operation is not allowed in the current state.
The offending command is ignored
and has no other side effect than to set the error flag.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_INVALID_FRAMEBUFFER_OPERATION</constant></term>
<listitem>
<para>
The framebuffer object is not complete. The offending command
is ignored and has no other side effect than to set the error flag.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_OUT_OF_MEMORY</constant></term>
<listitem>
<para>
There is not enough memory left to execute the command.
The state of the GL is undefined,
except for the state of the error flags,
after this error is recorded.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_STACK_UNDERFLOW</constant></term>
<listitem>
<para>
An attempt has been made to perform an operation that would
cause an internal stack to underflow.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_STACK_OVERFLOW</constant></term>
<listitem>
<para>
An attempt has been made to perform an operation that would
cause an internal stack to overflow.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
When an error flag is set,
results of a GL operation are undefined only if <constant>GL_OUT_OF_MEMORY</constant>
has occurred.
In all other cases,
the command generating the error is ignored and has no effect on the GL state
or frame buffer contents.
If the generating command returns a value, it returns 0.
If <function>glGetError</function> itself generates an error, it returns 0.
</para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glGetError</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='20']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<!-- TBD -->
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 1991-2006 Silicon Graphics, Inc.
Copyright <trademark class="copyright"/> 2010-2014 Khronos Group.
This document is licensed under the SGI
This document is licensed under the SGI
Free Software B License. For details, see
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</link>.
</para>
</refsect1>
</refentry>
|
