• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglWaitGL">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglWaitGL</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglWaitGL</refname>
14        <refpurpose>
15            Complete GL execution prior to subsequent native rendering
16            calls
17        </refpurpose>
18    </refnamediv>
19    <refsynopsisdiv>
20        <title>C Specification</title>
21        <funcsynopsis>
22            <funcprototype>
23                <funcdef>EGLBoolean <function>eglWaitGL</function></funcdef>
24                <void/>
25            </funcprototype>
26        </funcsynopsis>
27    </refsynopsisdiv>
28    <refsect1 xml:id="description"><title>Description</title>
29        <para>
30            All OpenGL ES rendering calls for the currently bound OpenGL
31            ES context made prior to <function>eglWaitGL</function> are
32            guaranteed to be executed before native rendering calls made
33            after <function>eglWaitGL</function>. The same result can be
34            achieved using
35            <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>.
36        </para>
37        <para>
38            <function>eglWaitGL</function> is ignored if there is no
39            current EGL rendering context for OpenGL ES.
40        </para>
41    </refsect1>
42    <refsect1 xml:id="notes"><title>Notes</title>
43        <para>
44            <function>eglWaitClient</function> is supported only if the
45            EGL version is 1.2 or greater.
46        </para>
47        <para>
48            <function>eglWaitClient</function> is a generalized version
49            of <function>eglWaitGL</function>, supporting multiple
50            client APIs. For backwards compatibility,
51            <function>eglWaitGL</function> continues to be supported and
52            is equivalent to the series of commands
53        </para>
54        <programlisting>
55              EGLenum api = <function>eglQueryAPI</function>();
56              <function>eglBindAPI</function>(<constant>EGL_OPENGL_ES_API</constant>);
57              <function>eglWaitClient</function>();
58              <function>eglBindAPI</function>(api);
59        </programlisting>
60    </refsect1>
61    <refsect1 xml:id="errors"><title>Errors</title>
62        <para>
63            <constant>EGL_FALSE</constant> is returned if
64            <function>eglWaitGL</function> fails,
65            <constant>EGL_TRUE</constant> otherwise.
66        </para>
67        <para>
68            <constant>EGL_BAD_CURRENT_SURFACE</constant> is generated if
69            the surface associated with the current context has a native
70            window or pixmap, and that window or pixmap is no longer
71            valid.
72        </para>
73    </refsect1>
74    <refsect1 xml:id="seealso"><title>See Also</title>
75        <para>
76            <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>,
77            <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>
78            <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry>
79        </para>
80    </refsect1>
81    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
82</refentry>
83