• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetError">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglGetError</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglGetError</refname>
14        <refpurpose>
15            return error information
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLint <function>eglGetError</function></funcdef>
23                <void/>
24            </funcprototype>
25        </funcsynopsis>
26    </refsynopsisdiv>
27    <refsect1 xml:id="description"><title>Description</title>
28        <para>
29            <function>eglGetError</function> returns the error of the last
30            called <acronym>EGL</acronym> function in the current thread.
31            Initially, the error is set to <constant>EGL_SUCCESS</constant>.
32        </para>
33        <para>
34            The following errors are currently defined:
35        </para>
36        <variablelist>
37            <varlistentry>
38            <term><constant>EGL_SUCCESS</constant></term>
39            <listitem><para>The last function succeeded without error.
40            </para></listitem>
41            </varlistentry>
42            <varlistentry>
43            <term><constant>EGL_NOT_INITIALIZED</constant></term>
44            <listitem><para>EGL is not initialized, or could not be initialized,
45                for the specified EGL display connection.
46            </para></listitem>
47            </varlistentry>
48            <varlistentry>
49            <term><constant>EGL_BAD_ACCESS</constant></term>
50            <listitem><para>EGL cannot access a requested resource
51                (for example a context is bound in another thread).
52            </para></listitem>
53            </varlistentry>
54            <varlistentry>
55            <term><constant>EGL_BAD_ALLOC</constant></term>
56            <listitem><para>EGL failed to allocate resources for the requested
57                operation.</para></listitem>
58            </varlistentry>
59            <varlistentry>
60            <term><constant>EGL_BAD_ATTRIBUTE</constant></term>
61            <listitem><para>An unrecognized attribute or attribute value was
62                passed in the attribute list.
63            </para></listitem>
64            </varlistentry>
65            <varlistentry>
66            <term><constant>EGL_BAD_CONTEXT</constant></term>
67            <listitem><para>An <type>EGLContext</type> argument does not name a
68                valid EGL rendering context.
69            </para></listitem>
70            </varlistentry>
71            <varlistentry>
72            <term><constant>EGL_BAD_CONFIG</constant></term>
73            <listitem><para>
74                An <type>EGLConfig</type> argument does not name a valid
75                EGL frame buffer configuration.
76            </para></listitem>
77            </varlistentry>
78            <varlistentry>
79            <term><constant>EGL_BAD_CURRENT_SURFACE</constant></term>
80            <listitem><para>The current surface of the calling thread is a window,
81                pixel buffer or pixmap that is no longer valid.
82            </para></listitem>
83            </varlistentry>
84            <varlistentry>
85            <term><constant>EGL_BAD_DISPLAY</constant></term>
86            <listitem><para>An <type>EGLDisplay</type> argument does not name a
87                valid EGL display connection.
88            </para></listitem>
89            </varlistentry>
90            <varlistentry>
91            <term><constant>EGL_BAD_SURFACE</constant></term>
92            <listitem><para>An <type>EGLSurface</type> argument does not name a
93                valid surface (window, pixel buffer or pixmap) configured for
94                GL rendering.
95            </para></listitem>
96            </varlistentry>
97            <varlistentry>
98            <term><constant>EGL_BAD_MATCH</constant></term>
99            <listitem><para>Arguments are inconsistent (for example, a valid
100                context requires buffers not supplied by a valid surface).
101            </para></listitem>
102            </varlistentry>
103            <varlistentry>
104            <term><constant>EGL_BAD_PARAMETER</constant></term>
105            <listitem><para>One or more argument values are invalid.</para></listitem>
106            </varlistentry>
107            <varlistentry>
108            <term><constant>EGL_BAD_NATIVE_PIXMAP</constant></term>
109            <listitem><para>
110                A <type>NativePixmapType</type> argument does not refer to
111                a valid native pixmap.
112            </para></listitem>
113            </varlistentry>
114            <varlistentry>
115            <term><constant>EGL_BAD_NATIVE_WINDOW</constant></term>
116            <listitem><para>A <type>NativeWindowType</type> argument does not refer
117                to a valid native window.
118            </para></listitem>
119            </varlistentry>
120            <varlistentry>
121            <term><constant>EGL_CONTEXT_LOST</constant></term>
122            <listitem><para>
123                A power management event has occurred. The application must destroy all
124                contexts and reinitialise OpenGL ES state and objects to continue rendering.
125            </para></listitem>
126            </varlistentry>
127        </variablelist>
128    </refsect1>
129    <refsect1 xml:id="errors"><title>Errors</title>
130        <para>
131            A call to <function>eglGetError</function> sets the error to
132            <constant>EGL_SUCCESS</constant>.
133        </para>
134    </refsect1>
135    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
136</refentry>
137