1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <title xmlns:xlink="http://www.w3.org/1999/xlink">eglGetError - EGL Reference Pages</title>
5    <link rel="stylesheet" type="text/css" href="khronos-man.css"/>
6    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/>
7  </head>
8  <body>
9    <header/>
10    <div class="refentry" id="eglGetError">
11      <div class="titlepage"/>
12      <div class="refnamediv">
13        <h2>Name</h2>
14        <p>eglGetError — 
15            return error information
16        </p>
17      </div>
18      <div class="refsynopsisdiv">
19        <h2>C Specification</h2>
20        <div class="funcsynopsis">
21          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
22            <tr>
23              <td>
24                <code class="funcdef">EGLint <strong class="fsfunc">eglGetError</strong>(</code>
25              </td>
26              <td><code>void)</code>;</td>
27              <td> </td>
28            </tr>
29          </table>
30          <div class="funcprototype-spacer"> </div>
31        </div>
32      </div>
33      <div class="refsect1" id="description">
34        <h2>Description</h2>
35        <p>
36            <code class="function">eglGetError</code> returns the error of the last
37            called <abbr class="acronym">EGL</abbr> function in the current thread.
38            Initially, the error is set to <code class="constant">EGL_SUCCESS</code>.
39        </p>
40        <p>
41            When an EGL function could potentially generate several
42            different errors (for example, when passed both a bad attribute
43            name, and a bad attribute value for a legal attribute name), the
44            implementation may choose to generate any one of the applicable
45            errors.
46        </p>
47        <p>
48            The following errors are currently defined:
49        </p>
50        <div class="variablelist">
51          <dl class="variablelist">
52            <dt>
53              <span class="term">
54                <code class="constant">EGL_SUCCESS</code>
55              </span>
56            </dt>
57            <dd>
58              <p>The last function succeeded without error.
59            </p>
60            </dd>
61            <dt>
62              <span class="term">
63                <code class="constant">EGL_NOT_INITIALIZED</code>
64              </span>
65            </dt>
66            <dd>
67              <p>EGL is not initialized, or could not be initialized,
68                for the specified EGL display connection.
69            </p>
70            </dd>
71            <dt>
72              <span class="term">
73                <code class="constant">EGL_BAD_ACCESS</code>
74              </span>
75            </dt>
76            <dd>
77              <p>EGL cannot access a requested resource
78                (for example a context is bound in another thread).
79            </p>
80            </dd>
81            <dt>
82              <span class="term">
83                <code class="constant">EGL_BAD_ALLOC</code>
84              </span>
85            </dt>
86            <dd>
87              <p>EGL failed to allocate resources for the requested
88                operation.</p>
89            </dd>
90            <dt>
91              <span class="term">
92                <code class="constant">EGL_BAD_ATTRIBUTE</code>
93              </span>
94            </dt>
95            <dd>
96              <p>An unrecognized attribute or attribute value was
97                passed in the attribute list.
98            </p>
99            </dd>
100            <dt>
101              <span class="term">
102                <code class="constant">EGL_BAD_CONTEXT</code>
103              </span>
104            </dt>
105            <dd>
106              <p>An <span class="type">EGLContext</span> argument does not name a
107                valid EGL rendering context.
108            </p>
109            </dd>
110            <dt>
111              <span class="term">
112                <code class="constant">EGL_BAD_CONFIG</code>
113              </span>
114            </dt>
115            <dd>
116              <p>
117                An <span class="type">EGLConfig</span> argument does not name a valid
118                EGL frame buffer configuration.
119            </p>
120            </dd>
121            <dt>
122              <span class="term">
123                <code class="constant">EGL_BAD_CURRENT_SURFACE</code>
124              </span>
125            </dt>
126            <dd>
127              <p>The current surface of the calling thread is a window,
128                pixel buffer or pixmap that is no longer valid.
129            </p>
130            </dd>
131            <dt>
132              <span class="term">
133                <code class="constant">EGL_BAD_DISPLAY</code>
134              </span>
135            </dt>
136            <dd>
137              <p>An <span class="type">EGLDisplay</span> argument does not name a
138                valid EGL display connection.
139            </p>
140            </dd>
141            <dt>
142              <span class="term">
143                <code class="constant">EGL_BAD_SURFACE</code>
144              </span>
145            </dt>
146            <dd>
147              <p>An <span class="type">EGLSurface</span> argument does not name a
148                valid surface (window, pixel buffer or pixmap) configured for
149                GL rendering.
150            </p>
151            </dd>
152            <dt>
153              <span class="term">
154                <code class="constant">EGL_BAD_MATCH</code>
155              </span>
156            </dt>
157            <dd>
158              <p>Arguments are inconsistent (for example, a valid
159                context requires buffers not supplied by a valid surface).
160            </p>
161            </dd>
162            <dt>
163              <span class="term">
164                <code class="constant">EGL_BAD_PARAMETER</code>
165              </span>
166            </dt>
167            <dd>
168              <p>One or more argument values are invalid.</p>
169            </dd>
170            <dt>
171              <span class="term">
172                <code class="constant">EGL_BAD_NATIVE_PIXMAP</code>
173              </span>
174            </dt>
175            <dd>
176              <p>
177                A <span class="type">NativePixmapType</span> argument does not refer to
178                a valid native pixmap.
179            </p>
180            </dd>
181            <dt>
182              <span class="term">
183                <code class="constant">EGL_BAD_NATIVE_WINDOW</code>
184              </span>
185            </dt>
186            <dd>
187              <p>A <span class="type">NativeWindowType</span> argument does not refer
188                to a valid native window.
189            </p>
190            </dd>
191            <dt>
192              <span class="term">
193                <code class="constant">EGL_CONTEXT_LOST</code>
194              </span>
195            </dt>
196            <dd>
197              <p>
198                A power management event has occurred. The application must destroy all
199                contexts and reinitialise OpenGL ES state and objects to continue rendering.
200            </p>
201            </dd>
202          </dl>
203        </div>
204      </div>
205      <div class="refsect1" id="errors">
206        <h2>Errors</h2>
207        <p>
208            A call to <code class="function">eglGetError</code> sets the error to
209            <code class="constant">EGL_SUCCESS</code>.
210        </p>
211      </div>
212      <p>
213    </p>
214      <div class="refsect3" id="copyright">
215        <img src="KhronosLogo.jpg"/>
216        <p>
217            Copyright © 2003-2014 The Khronos Group Inc.
218            Permission is hereby granted, free of charge, to any person obtaining a
219            copy of this software and/or associated documentation files (the
220            "Materials"), to deal in the Materials without restriction, including
221            without limitation the rights to use, copy, modify, merge, publish,
222            distribute, sublicense, and/or sell copies of the Materials, and to
223            permit persons to whom the Materials are furnished to do so, subject to
224            the condition that this copyright notice and permission notice shall be included
225            in all copies or substantial portions of the Materials.
226        </p>
227      </div>
228      <p>
229</p>
230    </div>
231    <footer/>
232  </body>
233</html>
234