1<?xml version="1.0" encoding="UTF-8"?> 2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" 3 "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> 4<refentry xml:base="" id="eglWaitClient"> 5 <refentryinfo> 6 <copyright> 7 <year>2003-2014</year> 8 <holder>The Khronos Group Inc.</holder> 9 </copyright> 10 </refentryinfo> 11 <refmeta> 12 <refentrytitle>eglWaitClient</refentrytitle> 13 <manvolnum>3G</manvolnum> 14 </refmeta> 15 <refnamediv> 16 <refname>eglWaitClient</refname> 17 <refpurpose> 18 Complete client API execution prior to subsequent native 19 rendering calls 20 </refpurpose> 21 </refnamediv> 22 <refsynopsisdiv> 23 <title>C Specification</title> 24 <funcsynopsis> 25 <funcprototype> 26 <funcdef>EGLBoolean <function>eglWaitClient</function></funcdef> 27 <void/> 28 </funcprototype> 29 </funcsynopsis> 30 </refsynopsisdiv> 31 <refsect1 id="description"><title>Description</title> 32 <para> 33 All rendering calls for the currently bound context, for the 34 current rendering API, made prior to 35 <function>eglWaitClient</function> are guaranteed to be 36 executed before native rendering calls made after 37 <function>eglWaitClient</function>. The same result can be 38 achieved using client API-specific commands such as 39 <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry> 40 or 41 <citerefentry><refentrytitle>vgFinish</refentrytitle></citerefentry>. 42 </para> 43 <para> 44 <function>eglWaitClient</function> is ignored if there is no 45 current EGL rendering context for the current rendering API. 46 </para> 47 </refsect1> 48 <refsect1 id="errors"><title>Errors</title> 49 <para> 50 <constant>EGL_FALSE</constant> is returned if 51 <function>eglWaitClient</function> fails, 52 <constant>EGL_TRUE</constant> otherwise. 53 </para> 54 <para> 55 If there is no current context for the current rendering 56 API, the function has no effect but still returns 57 <constant>EGL_TRUE</constant>. 58 </para> 59 <para> 60 <constant>EGL_BAD_CURRENT_SURFACE</constant> is generated if 61 the surface associated with the current context has a native 62 window or pixmap, and that window or pixmap is no longer 63 valid. 64 </para> 65 </refsect1> 66 <refsect1 id="notes"><title>Notes</title> 67 <para> 68 <function>eglWaitClient</function> is supported only if the 69 EGL version is 1.2 or greater. 70 </para> 71 <para> 72 <function>eglWaitClient</function> is a generalized version 73 of <function>eglWaitGL</function>, supporting multiple 74 client APIs. 75 </para> 76 </refsect1> 77 <refsect1 id="seealso"><title>See Also</title> 78 <para> 79 <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>, 80 <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>, 81 <citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry>, 82 <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry>, 83 <citerefentry><refentrytitle>vgFinish</refentrytitle></citerefentry> 84 </para> 85 </refsect1> 86 <refsect3 id="Copyright"><title></title> 87 <!-- Content included from copyright.inc.xsl --> 88 <imageobject> 89 <imagedata fileref="KhronosLogo.jpg" format="jpg" /> 90 </imageobject> 91 <para /> 92 </refsect3> 93</refentry> 94
