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>glWaitSync
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.75.2" /></head><body><div class=
"refentry" title=
"glWaitSync"><a id=
"glWaitSync"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glWaitSync — instruct the GL server to block until the specified sync object becomes signaled
</p></div><div class=
"refsynopsisdiv" title=
"C Specification"><h2>C Specification
</h2><div class=
"funcsynopsis"><table border=
"0" summary=
"Function synopsis" cellspacing=
"0" cellpadding=
"0" class=
"funcprototype-table"><tr><td><code class=
"funcdef">void
<b class=
"fsfunc">glWaitSync
</b>(
</code></td><td>GLsync
<var class=
"pdparam">sync
</var>,
</td></tr><tr><td> </td><td>GLbitfield
<var class=
"pdparam">flags
</var>,
</td></tr><tr><td> </td><td>GLuint64
<var class=
"pdparam">timeout
</var><code>)
</code>;
</td></tr></table><div class=
"funcprototype-spacer"> </div></div></div><div class=
"refsect1" title=
"Parameters"><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 Specifies 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 zero.
8 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>timeout
</code></em></span></dt><dd><p>
9 Specifies the timeout that the server should wait before continuing.
<em class=
"parameter"><code>timeout
</code></em> must be
<code class=
"constant">GL_TIMEOUT_IGNORED
</code>.
10 </p></dd></dl></div></div><div class=
"refsect1" title=
"Description"><a id=
"description"></a><h2>Description
</h2><p>
11 <code class=
"function">glWaitSync
</code> causes the GL server to block and wait until
<em class=
"parameter"><code>sync
</code></em> becomes signaled.
<em class=
"parameter"><code>sync
</code></em>
12 is the name of an existing sync object upon which to wait.
<em class=
"parameter"><code>flags
</code></em> and
<em class=
"parameter"><code>timeout
</code></em> are currently not used and
13 must be set to zero and the special value
<code class=
"constant">GL_TIMEOUT_IGNORED
</code>, respectively
<sup>[
<a id=
"id392884" href=
"#ftn.id392884" class=
"footnote">1</a>]
</sup>.
<code class=
"function">glWaitSync
</code> will always wait no longer than an implementation-dependent timeout. The
14 duration of this timeout in nanoseconds may be queried by calling
<a class=
"citerefentry" href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with the
15 parameter
<code class=
"constant">GL_MAX_SERVER_WAIT_TIMEOUT
</code>. There is currently no way to determine whether
<code class=
"function">glWaitSync
</code> unblocked
16 because the timeout expired or because the sync object being waited on was signaled.
18 If an error occurs,
<code class=
"function">glWaitSync
</code> does not cause the GL server to block.
19 </p></div><div class=
"refsect1" title=
"Notes"><a id=
"notes"></a><h2>Notes
</h2><p>
20 <code class=
"function">glWaitSync
</code> is available only if the GL version is
3.2 or higher.
21 </p></div><div class=
"refsect1" title=
"Errors"><a id=
"errors"></a><h2>Errors
</h2><p>
22 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if
<em class=
"parameter"><code>sync
</code></em> is not the name of a sync object.
24 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>flags
</code></em> is not zero.
26 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>timeout
</code></em> is not
<code class=
"constant">GL_TIMEOUT_IGNORED
</code>.
27 </p></div><div class=
"refsect1" title=
"See Also"><a id=
"seealso"></a><h2>See Also
</h2><p>
28 <a class=
"citerefentry" href=
"glFenceSync.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glFenceSync
</span></span></a>,
29 <a class=
"citerefentry" href=
"glClientWaitSync.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glClientWaitSync
</span></span></a>
30 </p></div><div class=
"refsect1" title=
"Copyright"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
31 Copyright
<span class=
"trademark"></span>©
2010 Khronos Group.
32 This material may be distributed subject to the terms and conditions set forth in
33 the Open Publication License, v
1.0,
8 June
1999.
34 <a class=
"ulink" href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
35 </p></div><div class=
"footnotes"><br /><hr width=
"100" align=
"left" /><div class=
"footnote"><p><sup>[
<a id=
"ftn.id392884" href=
"#id392884" class=
"para">1</a>]
</sup><em class=
"parameter"><code>flags
</code></em> and
36 <em class=
"parameter"><code>timeout
</code></em> are placeholders for anticipated future extensions of sync object capabilities. They must have these reserved values in
37 order that existing code calling
<code class=
"function">glWaitSync
</code> operate properly in the presence of such extensions.
</p></div></div></div></body></html>