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