aboutsummaryrefslogtreecommitdiff
path: root/glew/auto/EGL-Registry/sdk/docs/man/eglGetError.xml
blob: 3e1fd71650f88affc8b2e7b96a8299f2acda7339 (plain)
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
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetError">
    <info>
         <copyright>
             <year>2003-2014</year>
             <holder>The Khronos Group Inc.</holder>
         </copyright>
    </info>
    <refmeta>
        <refentrytitle>eglGetError</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>eglGetError</refname>
        <refpurpose>
            return error information
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>EGLint <function>eglGetError</function></funcdef>
                <void/>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>eglGetError</function> returns the error of the last
            called <acronym>EGL</acronym> function in the current thread.
            Initially, the error is set to <constant>EGL_SUCCESS</constant>.
        </para>
        <para>
            When an EGL function could potentially generate several
            different errors (for example, when passed both a bad attribute
            name, and a bad attribute value for a legal attribute name), the
            implementation may choose to generate any one of the applicable
            errors.
        </para>
        <para>
            The following errors are currently defined:
        </para>
        <variablelist>
            <varlistentry>
            <term><constant>EGL_SUCCESS</constant></term>
            <listitem><para>The last function succeeded without error.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_NOT_INITIALIZED</constant></term>
            <listitem><para>EGL is not initialized, or could not be initialized,
                for the specified EGL display connection.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_ACCESS</constant></term>
            <listitem><para>EGL cannot access a requested resource
                (for example a context is bound in another thread).
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_ALLOC</constant></term>
            <listitem><para>EGL failed to allocate resources for the requested
                operation.</para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_ATTRIBUTE</constant></term>
            <listitem><para>An unrecognized attribute or attribute value was
                passed in the attribute list.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_CONTEXT</constant></term>
            <listitem><para>An <type>EGLContext</type> argument does not name a
                valid EGL rendering context.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_CONFIG</constant></term>
            <listitem><para>
                An <type>EGLConfig</type> argument does not name a valid
                EGL frame buffer configuration.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_CURRENT_SURFACE</constant></term>
            <listitem><para>The current surface of the calling thread is a window,
                pixel buffer or pixmap that is no longer valid.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_DISPLAY</constant></term>
            <listitem><para>An <type>EGLDisplay</type> argument does not name a
                valid EGL display connection.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_SURFACE</constant></term>
            <listitem><para>An <type>EGLSurface</type> argument does not name a
                valid surface (window, pixel buffer or pixmap) configured for
                GL rendering.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_MATCH</constant></term>
            <listitem><para>Arguments are inconsistent (for example, a valid
                context requires buffers not supplied by a valid surface).
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_PARAMETER</constant></term>
            <listitem><para>One or more argument values are invalid.</para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_NATIVE_PIXMAP</constant></term>
            <listitem><para>
                A <type>NativePixmapType</type> argument does not refer to
                a valid native pixmap.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_BAD_NATIVE_WINDOW</constant></term>
            <listitem><para>A <type>NativeWindowType</type> argument does not refer
                to a valid native window.
            </para></listitem>
            </varlistentry>
            <varlistentry>
            <term><constant>EGL_CONTEXT_LOST</constant></term>
            <listitem><para>
                A power management event has occurred. The application must destroy all
                contexts and reinitialise OpenGL ES state and objects to continue rendering.
            </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="errors"><title>Errors</title>
        <para>
            A call to <function>eglGetError</function> sets the error to
            <constant>EGL_SUCCESS</constant>.
        </para>
    </refsect1>
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
</refentry>