• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglWaitNative">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglWaitNative</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglWaitNative</refname>
14        <refpurpose>
15            complete native execution prior to subsequent GL rendering calls
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLBoolean <function>eglWaitNative</function></funcdef>
23                <paramdef>EGLint <parameter>engine</parameter></paramdef>
24            </funcprototype>
25        </funcsynopsis>
26    </refsynopsisdiv>
27    <refsect1 xml:id="parameters"><title>Parameters</title>
28        <variablelist>
29            <varlistentry>
30                <term><parameter>engine</parameter></term>
31                <listitem>
32                    <para>
33                        Specifies a particular marking engine to be waited on.
34                        Must be <constant>EGL_CORE_NATIVE_ENGINE</constant>.
35                    </para>
36                </listitem>
37            </varlistentry>
38        </variablelist>
39    </refsect1>
40    <refsect1 xml:id="description"><title>Description</title>
41        <para>
42            Native rendering calls made prior to <function>eglWaitNative</function>
43            are guaranteed to be executed before GL rendering calls made after
44            <function>eglWaitNative</function>.
45        </para>
46        <para>
47            <function>eglWaitNative</function>
48            is ignored if there is no current
49            <acronym>EGL</acronym>
50            rendering context.
51        </para>
52    </refsect1>
53    <refsect1 xml:id="errors"><title>Errors</title>
54        <para>
55            <constant>EGL_BAD_PARAMETER</constant> is generated if
56            <parameter>engine</parameter> is not a recognized marking engine.
57        </para>
58        <para>
59            <constant>EGL_BAD_CURRENT_SURFACE</constant>
60            is generated if the surface associated with the current context has a
61            native window or pixmap, and that window or pixmap is no longer valid.
62        </para>
63    </refsect1>
64    <refsect1 xml:id="seealso"><title>See Also</title>
65        <para>
66            <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>,
67            <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>,
68            <citerefentry><refentrytitle>eglWaitClient</refentrytitle></citerefentry>,
69            <citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry>
70        </para>
71    </refsect1>
72    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
73</refentry>
74