1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?xml-stylesheet type=
"text/xsl" href=
"mathml.xsl"?><html xmlns=
"http://www.w3.org/1999/xhtml" xmlns:
pref=
"http://www.w3.org/2002/Math/preference" pref:
renderer=
"mathplayer-dl"><head><meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" /><link rel=
"stylesheet" type=
"text/css" href=
"opengl-man.css" /><title>glClientWaitSync - OpenGL
4 Reference Pages
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.69.1" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glClientWaitSync"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glClientWaitSync — block and wait for a sync object to become signaled
</p></div><div class=
"refsynopsisdiv"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0"><tr><td><code class=
"funcdef">GLenum
<b class=
"fsfunc">glClientWaitSync
</b>(
</code></td><td>GLsync
</td><td><var class=
"pdparam">sync
</var>,
</td></tr><tr><td> </td><td>GLbitfield
</td><td><var class=
"pdparam">flags
</var>,
</td></tr><tr><td> </td><td>GLuint64
</td><td><var class=
"pdparam">timeout
</var><code>)
</code>;
</td></tr></table></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"parameters"></a><h2>Parameters
</h2><div class=
"variablelist"><dl><dt><span class=
"term"><em class=
"parameter"><code>sync
</code></em></span></dt><dd><p>
5 The sync object whose status to wait on.
6 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>flags
</code></em></span></dt><dd><p>
7 A bitfield controlling the command flushing behavior.
<em class=
"parameter"><code>flags
</code></em> may be
<code class=
"constant">GL_SYNC_FLUSH_COMMANDS_BIT
</code>.
8 </p></dd></dl></div><dt><span class=
"term"><em class=
"parameter"><code>timeout
</code></em></span></dt><dd><p>
9 The timeout, specified in nanoseconds, for which the implementation should wait for
<em class=
"parameter"><code>sync
</code></em> to become signaled.
10 </p></dd></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
11 <code class=
"function">glClientWaitSync
</code> causes the client to block and wait for the sync object specified by
<em class=
"parameter"><code>sync
</code></em> to become signaled. If
12 <em class=
"parameter"><code>sync
</code></em> is signaled when
<code class=
"function">glClientWaitSync
</code> is called,
<code class=
"function">glClientWaitSync
</code> returns immediately, otherwise
13 it will block and wait for up to
<em class=
"parameter"><code>timeout
</code></em> nanoseconds for
<em class=
"parameter"><code>sync
</code></em> to become signaled.
15 The return value is one of four status values:
16 </p><div class=
"itemizedlist"><ul type=
"disc"><li><p>
17 <code class=
"constant">GL_ALREADY_SIGNALED
</code> indicates that
<em class=
"parameter"><code>sync
</code></em> was signaled at the time that
<code class=
"function">glClientWaitSync
</code>
20 <code class=
"constant">GL_TIMEOUT_EXPIRED
</code> indicates that at least
<em class=
"parameter"><code>timeout
</code></em> nanoseconds passed and
<em class=
"parameter"><code>sync
</code></em> did not
23 <code class=
"constant">GL_CONDITION_SATISFIED
</code> indicates that
<em class=
"parameter"><code>sync
</code></em> was signaled before the timeout expired.
25 <code class=
"constant">GL_WAIT_FAILED
</code> indicates that an error occurred. Additionally, an OpenGL error will be generated.
26 </p></li></ul></div><p>
27 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p>
28 <code class=
"function">glClientWaitSync
</code> is available only if the GL version is
3.2 or greater.
29 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
30 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>sync
</code></em> is not the name of an existing sync object.
32 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>flags
</code></em> contains any unsupported flag.
33 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
34 <a href=
"glFenceSync.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glFenceSync
</span></span></a>,
35 <a href=
"glIsSync.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glIsSync
</span></span></a>
36 <a href=
"glWaitSync.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glWaitSync
</span></span></a>
37 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
38 Copyright
<span class=
"trademark"></span>©
2010 Khronos Group.
39 This material may be distributed subject to the terms and conditions set forth in
40 the Open Publication License, v
1.0,
8 June
1999.
41 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
42 </p></div></div></body></html>