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 When an EGL function could potentially generate several 35 different errors (for example, when passed both a bad attribute 36 name, and a bad attribute value for a legal attribute name), the 37 implementation may choose to generate any one of the applicable 38 errors. 39 </para> 40 <para> 41 The following errors are currently defined: 42 </para> 43 <variablelist> 44 <varlistentry> 45 <term><constant>EGL_SUCCESS</constant></term> 46 <listitem><para>The last function succeeded without error. 47 </para></listitem> 48 </varlistentry> 49 <varlistentry> 50 <term><constant>EGL_NOT_INITIALIZED</constant></term> 51 <listitem><para>EGL is not initialized, or could not be initialized, 52 for the specified EGL display connection. 53 </para></listitem> 54 </varlistentry> 55 <varlistentry> 56 <term><constant>EGL_BAD_ACCESS</constant></term> 57 <listitem><para>EGL cannot access a requested resource 58 (for example a context is bound in another thread). 59 </para></listitem> 60 </varlistentry> 61 <varlistentry> 62 <term><constant>EGL_BAD_ALLOC</constant></term> 63 <listitem><para>EGL failed to allocate resources for the requested 64 operation.</para></listitem> 65 </varlistentry> 66 <varlistentry> 67 <term><constant>EGL_BAD_ATTRIBUTE</constant></term> 68 <listitem><para>An unrecognized attribute or attribute value was 69 passed in the attribute list. 70 </para></listitem> 71 </varlistentry> 72 <varlistentry> 73 <term><constant>EGL_BAD_CONTEXT</constant></term> 74 <listitem><para>An <type>EGLContext</type> argument does not name a 75 valid EGL rendering context. 76 </para></listitem> 77 </varlistentry> 78 <varlistentry> 79 <term><constant>EGL_BAD_CONFIG</constant></term> 80 <listitem><para> 81 An <type>EGLConfig</type> argument does not name a valid 82 EGL frame buffer configuration. 83 </para></listitem> 84 </varlistentry> 85 <varlistentry> 86 <term><constant>EGL_BAD_CURRENT_SURFACE</constant></term> 87 <listitem><para>The current surface of the calling thread is a window, 88 pixel buffer or pixmap that is no longer valid. 89 </para></listitem> 90 </varlistentry> 91 <varlistentry> 92 <term><constant>EGL_BAD_DISPLAY</constant></term> 93 <listitem><para>An <type>EGLDisplay</type> argument does not name a 94 valid EGL display connection. 95 </para></listitem> 96 </varlistentry> 97 <varlistentry> 98 <term><constant>EGL_BAD_SURFACE</constant></term> 99 <listitem><para>An <type>EGLSurface</type> argument does not name a 100 valid surface (window, pixel buffer or pixmap) configured for 101 GL rendering. 102 </para></listitem> 103 </varlistentry> 104 <varlistentry> 105 <term><constant>EGL_BAD_MATCH</constant></term> 106 <listitem><para>Arguments are inconsistent (for example, a valid 107 context requires buffers not supplied by a valid surface). 108 </para></listitem> 109 </varlistentry> 110 <varlistentry> 111 <term><constant>EGL_BAD_PARAMETER</constant></term> 112 <listitem><para>One or more argument values are invalid.</para></listitem> 113 </varlistentry> 114 <varlistentry> 115 <term><constant>EGL_BAD_NATIVE_PIXMAP</constant></term> 116 <listitem><para> 117 A <type>NativePixmapType</type> argument does not refer to 118 a valid native pixmap. 119 </para></listitem> 120 </varlistentry> 121 <varlistentry> 122 <term><constant>EGL_BAD_NATIVE_WINDOW</constant></term> 123 <listitem><para>A <type>NativeWindowType</type> argument does not refer 124 to a valid native window. 125 </para></listitem> 126 </varlistentry> 127 <varlistentry> 128 <term><constant>EGL_CONTEXT_LOST</constant></term> 129 <listitem><para> 130 A power management event has occurred. The application must destroy all 131 contexts and reinitialise OpenGL ES state and objects to continue rendering. 132 </para></listitem> 133 </varlistentry> 134 </variablelist> 135 </refsect1> 136 <refsect1 xml:id="errors"><title>Errors</title> 137 <para> 138 A call to <function>eglGetError</function> sets the error to 139 <constant>EGL_SUCCESS</constant>. 140 </para> 141 </refsect1> 142 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> 143</refentry> 144