• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <title xmlns:xlink="http://www.w3.org/1999/xlink">eglWaitClient - EGL Reference Pages</title>
5    <link rel="stylesheet" type="text/css" href="khronos-man.css"/>
6    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/>
7  </head>
8  <body>
9    <header/>
10    <div class="refentry" id="eglWaitClient">
11      <div class="titlepage"/>
12      <div class="refnamediv">
13        <h2>Name</h2>
14        <p>eglWaitClient —
15            Complete client API execution prior to subsequent native
16            rendering calls
17        </p>
18      </div>
19      <div class="refsynopsisdiv">
20        <h2>C Specification</h2>
21        <div class="funcsynopsis">
22          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
23            <tr>
24              <td>
25                <code class="funcdef">EGLBoolean <strong class="fsfunc">eglWaitClient</strong>(</code>
26              </td>
27              <td><code>void)</code>;</td>
28              <td> </td>
29            </tr>
30          </table>
31          <div class="funcprototype-spacer"> </div>
32        </div>
33      </div>
34      <div class="refsect1" id="description">
35        <h2>Description</h2>
36        <p>
37            All rendering calls for the currently bound context, for the
38            current rendering API, made prior to
39            <code class="function">eglWaitClient</code> are guaranteed to be
40            executed before native rendering calls made after
41            <code class="function">eglWaitClient</code>. The same result can be
42            achieved using client API-specific commands such as
43            <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>
44            or
45            <a class="citerefentry" href="vgFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a>.
46        </p>
47        <p>
48            <code class="function">eglWaitClient</code> is ignored if there is no
49            current EGL rendering context for the current rendering API.
50        </p>
51      </div>
52      <div class="refsect1" id="errors">
53        <h2>Errors</h2>
54        <p>
55            <code class="constant">EGL_FALSE</code> is returned if
56            <code class="function">eglWaitClient</code> fails,
57            <code class="constant">EGL_TRUE</code> otherwise.
58        </p>
59        <p>
60            If there is no current context for the current rendering
61            API, the function has no effect but still returns
62            <code class="constant">EGL_TRUE</code>.
63        </p>
64        <p>
65            <code class="constant">EGL_BAD_CURRENT_SURFACE</code> is generated if
66            the surface associated with the current context has a native
67            window or pixmap, and that window or pixmap is no longer
68            valid.
69        </p>
70      </div>
71      <div class="refsect1" id="notes">
72        <h2>Notes</h2>
73        <p>
74            <code class="function">eglWaitClient</code> is supported only if the
75            EGL version is 1.2 or greater.
76        </p>
77        <p>
78            <code class="function">eglWaitClient</code> is a generalized version
79            of <code class="function">eglWaitGL</code>, supporting multiple
80            client APIs.
81        </p>
82      </div>
83      <div class="refsect1" id="seealso">
84        <h2>See Also</h2>
85        <p>
86            <a class="citerefentry" href="glFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">glFinish</span></span></a>,
87            <a class="citerefentry" href="glFlush.xhtml"><span class="citerefentry"><span class="refentrytitle">glFlush</span></span></a>,
88            <a class="citerefentry" href="eglWaitGL.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitGL</span></span></a>,
89            <a class="citerefentry" href="eglWaitNative.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitNative</span></span></a>,
90            <a class="citerefentry" href="vgFinish.xhtml"><span class="citerefentry"><span class="refentrytitle">vgFinish</span></span></a>
91        </p>
92      </div>
93      <p>
94    </p>
95      <div class="refsect3" id="copyright">
96        <img src="KhronosLogo.jpg"/>
97        <p>
98            Copyright © 2003-2014 The Khronos Group Inc.
99            Permission is hereby granted, free of charge, to any person obtaining a
100            copy of this software and/or associated documentation files (the
101            "Materials"), to deal in the Materials without restriction, including
102            without limitation the rights to use, copy, modify, merge, publish,
103            distribute, sublicense, and/or sell copies of the Materials, and to
104            permit persons to whom the Materials are furnished to do so, subject to
105            the condition that this copyright notice and permission notice shall be included
106            in all copies or substantial portions of the Materials.
107        </p>
108      </div>
109      <p>
110</p>
111    </div>
112    <footer/>
113  </body>
114</html>
115