/
glGetError.xhtml
269 lines (268 loc) · 12 KB
/
glGetError.xhtml
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<div class="refentry" id="glGetError">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glGetError — return error information</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">GLenum <strong class="fsfunc">glGetError</strong>(</code>
</td>
<td> <var class="pdparam">void</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glGetError</code> 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 <code class="function">glGetError</code> is called,
the error code is returned,
and the flag is reset to <code class="constant">GL_NO_ERROR</code>.
If a call to <code class="function">glGetError</code> returns <code class="constant">GL_NO_ERROR</code>,
there has been no detectable error since the last call to <code class="function">glGetError</code>,
or since the GL was initialized.
</p>
<p>
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 <code class="constant">GL_NO_ERROR</code>
when <code class="function">glGetError</code> is called.
If more than one flag has recorded an error,
<code class="function">glGetError</code> returns and clears an arbitrary error flag value.
Thus, <code class="function">glGetError</code> should always be called in a loop,
until it returns <code class="constant">GL_NO_ERROR</code>,
if all error flags are to be reset.
</p>
<p>
Initially, all error flags are set to <code class="constant">GL_NO_ERROR</code>.
</p>
<p>
The following errors are currently defined:
</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="constant">GL_NO_ERROR</code>
</span>
</dt>
<dd>
<p>
No error has been recorded.
The value of this symbolic constant is guaranteed to be 0.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_INVALID_ENUM</code>
</span>
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_INVALID_VALUE</code>
</span>
</dt>
<dd>
<p>
A numeric argument is out of range.
The offending command is ignored
and has no other side effect than to set the error flag.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_INVALID_OPERATION</code>
</span>
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_INVALID_FRAMEBUFFER_OPERATION</code>
</span>
</dt>
<dd>
<p>
The framebuffer object is not complete. The offending command
is ignored and has no other side effect than to set the error flag.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_OUT_OF_MEMORY</code>
</span>
</dt>
<dd>
<p>
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.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_STACK_UNDERFLOW</code>
</span>
</dt>
<dd>
<p>
An attempt has been made to perform an operation that would
cause an internal stack to underflow.
</p>
</dd>
<dt>
<span class="term">
<code class="constant">GL_STACK_OVERFLOW</code>
</span>
</dt>
<dd>
<p>
An attempt has been made to perform an operation that would
cause an internal stack to overflow.
</p>
</dd>
</dl>
</div>
<p>
When an error flag is set,
results of a GL operation are undefined only if <code class="constant">GL_OUT_OF_MEMORY</code>
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 <code class="function">glGetError</code> itself generates an error, it returns 0.
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glGetError</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 1991-2006 Silicon Graphics, Inc.
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
<a class="link" href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.
</p>
</div>
</div>