blob: 5f88491ca4a40d55b8d9991557239d0bf1df5e80 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="">
<title xmlns:xlink="">eglWaitClient - EGL Reference Pages</title>
<link rel="stylesheet" type="text/css" href="khronos-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/>
<div class="refentry" id="eglWaitClient">
<div class="titlepage"/>
<div class="refnamediv">
<p>eglWaitClient —
Complete client API execution prior to subsequent native
rendering calls
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<code class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitClient</strong>(</code>
<td> </td>
<div class="funcprototype-spacer"> </div>
<div class="refsect1" id="description">
All rendering calls for the currently bound context, for the
current rendering API, made prior to
<code class="function">eglWaitClient</code> are guaranteed to be
executed before native rendering calls made after
<code class="function">eglWaitClient</code>. The same result can be
achieved using client API-specific commands such as
<a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>
<a class="citerefentry" href="vgFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a>.
<code class="function">eglWaitClient</code> is ignored if there is no
current EGL rendering context for the current rendering API.
<div class="refsect1" id="errors">
<code class="constant">EGL_FALSE</code> is returned if
<code class="function">eglWaitClient</code> fails,
<code class="constant">EGL_TRUE</code> otherwise.
If there is no current context for the current rendering
API, the function has no effect but still returns
<code class="constant">EGL_TRUE</code>.
<code class="constant">EGL_BAD_CURRENT_SURFACE</code> is generated if
the surface associated with the current context has a native
window or pixmap, and that window or pixmap is no longer
<div class="refsect1" id="notes">
<code class="function">eglWaitClient</code> is supported only if the
EGL version is 1.2 or greater.
<code class="function">eglWaitClient</code> is a generalized version
of <code class="function">eglWaitGL</code>, supporting multiple
client APIs.
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>,
<a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>,
<a class="citerefentry" href="eglWaitGL.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a>,
<a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a>,
<a class="citerefentry" href="vgFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a>
<div class="refsect3" id="copyright">
<img src="KhronosLogo.jpg"/>
Copyright © 2003-2014 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.