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