Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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>glFenceSync</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glFenceSync"><a id="glFenceSync"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glFenceSync — create a new sync object and insert it into the GL command stream</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">GLsync <b class="fsfunc">glFenceSync</b>(</code></td><td>GLenum <var class="pdparam">condition</var>, </td></tr><tr><td> </td><td>GLbitfield <var class="pdparam">flags</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>condition</code></em></span></dt><dd><p> | |
5 | Specifies the condition that must be met to set the sync object's state to signaled. <em class="parameter"><code>condition</code></em> | |
6 | must be <code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>. | |
7 | </p></dd><dt><span class="term"><em class="parameter"><code>flags</code></em></span></dt><dd><p> | |
8 | Specifies a bitwise combination of flags controlling the behavior of the sync object. No flags are presently defined | |
9 | for this operation and <em class="parameter"><code>flags</code></em> must be zero.<sup>[<a id="id390503" href="#ftn.id390503" class="footnote">1</a>]</sup> | |
10 | </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p> | |
11 | <code class="function">glFenceSync</code> creates a new fence sync object, inserts a fence command into the GL command stream and | |
12 | associates it with that sync object, and returns a non-zero name corresponding to the sync object. | |
13 | </p><p> | |
14 | When the specified <em class="parameter"><code>condition</code></em> of the sync object is satisfied by the fence command, the sync object | |
15 | is signaled by the GL, causing any <a class="citerefentry" href="glWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>, | |
16 | <a class="citerefentry" href="glClientWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> commands blocking in <em class="parameter"><code>sync</code></em> | |
17 | to <span class="emphasis"><em>unblock</em></span>. No other state is affected by <code class="function">glFenceSync</code> or by the execution | |
18 | of the associated fence command. | |
19 | </p><p> | |
20 | <em class="parameter"><code>condition</code></em> must be <code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>. This condition is satisfied by | |
21 | completion of the fence command corresponding to the sync object and all preceding commands in the same command stream. | |
22 | The sync object will not be signaled until all effects from these commands on GL client and server state and the | |
23 | framebuffer are fully realized. Note that completion of the fence command occurs once the state of the corresponding sync | |
24 | object has been changed, but commands waiting on that sync object may not be unblocked until after the fence command completes. | |
25 | </p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><code class="function">glFenceSync</code> is only supported if the GL version is 3.2 or greater, or if | |
26 | the <code class="code">ARB_sync</code> extension is supported. | |
27 | </div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p> | |
28 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>condition</code></em> is not | |
29 | <code class="constant">GL_SYNC_GPU_COMMANDS_COMPLETE</code>. | |
30 | </p><p> | |
31 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>flags</code></em> is not zero. | |
32 | </p><p> | |
33 | Additionally, if <code class="function">glFenceSync</code> fails, it will return zero. | |
34 | </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p> | |
35 | <a class="citerefentry" href="glDeleteSync.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteSync</span></span></a>, | |
36 | <a class="citerefentry" href="glGetSync.xml"><span class="citerefentry"><span class="refentrytitle">glGetSync</span></span></a>, | |
37 | <a class="citerefentry" href="glWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>, | |
38 | <a class="citerefentry" href="glClientWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> | |
39 | </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p> | |
40 | Copyright <span class="trademark"></span>© 2010 Khronos Group. | |
41 | This material may be distributed subject to the terms and conditions set forth in | |
42 | the Open Publication License, v 1.0, 8 June 1999. | |
43 | <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
44 | </p></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id390503" href="#id390503" class="para">1</a>] </sup> | |
45 | <em class="parameter"><code>flags</code></em> is a placeholder for anticipated future extensions of fence sync object capabilities. | |
46 | </p></div></div></div></body></html> |