summaryrefslogtreecommitdiff
path: root/glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml
diff options
context:
space:
mode:
authorsotech117 <michael_foiani@brown.edu>2024-04-09 03:14:17 -0400
committersotech117 <michael_foiani@brown.edu>2024-04-09 03:14:17 -0400
commit7a8d0d8bc2572707c9d35006f30ea835c86954b0 (patch)
treededb9a65c1698202ad485378b4186b667008abe5 /glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml
parent818324678bd5dca790c57048e5012d2937a4b5e5 (diff)
first draft to generate waves
Diffstat (limited to 'glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml')
-rw-r--r--glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml84
1 files changed, 84 insertions, 0 deletions
diff --git a/glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml
new file mode 100644
index 0000000..a77cf00
--- /dev/null
+++ b/glew/auto/EGL-Registry/sdk/docs/man/eglWaitClient.xml
@@ -0,0 +1,84 @@
+<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglWaitClient">
+ <info>
+ <copyright>
+ <year>2003-2014</year>
+ <holder>The Khronos Group Inc.</holder>
+ </copyright>
+ </info>
+ <refmeta>
+ <refentrytitle>eglWaitClient</refentrytitle>
+ <manvolnum>3G</manvolnum>
+ </refmeta>
+ <refnamediv>
+ <refname>eglWaitClient</refname>
+ <refpurpose>
+ Complete client API execution prior to subsequent native
+ rendering calls
+ </refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <title>C Specification</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>EGLBoolean <function>eglWaitClient</function></funcdef>
+ <void/>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsect1 xml:id="description"><title>Description</title>
+ <para>
+ All rendering calls for the currently bound context, for the
+ current rendering API, made prior to
+ <function>eglWaitClient</function> are guaranteed to be
+ executed before native rendering calls made after
+ <function>eglWaitClient</function>. The same result can be
+ achieved using client API-specific commands such as
+ <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>
+ or
+ <citerefentry><refentrytitle>vgFinish</refentrytitle></citerefentry>.
+ </para>
+ <para>
+ <function>eglWaitClient</function> is ignored if there is no
+ current EGL rendering context for the current rendering API.
+ </para>
+ </refsect1>
+ <refsect1 xml:id="errors"><title>Errors</title>
+ <para>
+ <constant>EGL_FALSE</constant> is returned if
+ <function>eglWaitClient</function> fails,
+ <constant>EGL_TRUE</constant> otherwise.
+ </para>
+ <para>
+ If there is no current context for the current rendering
+ API, the function has no effect but still returns
+ <constant>EGL_TRUE</constant>.
+ </para>
+ <para>
+ <constant>EGL_BAD_CURRENT_SURFACE</constant> is generated if
+ the surface associated with the current context has a native
+ window or pixmap, and that window or pixmap is no longer
+ valid.
+ </para>
+ </refsect1>
+ <refsect1 xml:id="notes"><title>Notes</title>
+ <para>
+ <function>eglWaitClient</function> is supported only if the
+ EGL version is 1.2 or greater.
+ </para>
+ <para>
+ <function>eglWaitClient</function> is a generalized version
+ of <function>eglWaitGL</function>, supporting multiple
+ client APIs.
+ </para>
+ </refsect1>
+ <refsect1 xml:id="seealso"><title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>,
+ <citerefentry><refentrytitle>glFlush</refentrytitle></citerefentry>,
+ <citerefentry><refentrytitle>eglWaitGL</refentrytitle></citerefentry>,
+ <citerefentry><refentrytitle>eglWaitNative</refentrytitle></citerefentry>,
+ <citerefentry><refentrytitle>vgFinish</refentrytitle></citerefentry>
+ </para>
+ </refsect1>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
+</refentry>