forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glDeleteSync.xhtml
30 lines (30 loc) · 3.8 KB
/
glDeleteSync.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<div class="refentry"><a id="glDeleteSync"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDeleteSync — delete a sync object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glDeleteSync</strong>(</code></td><td>GLsync <var class="pdparam">sync</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>sync</code></em></span></dt><dd><p>
The sync object to be deleted.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glDeleteSync</code> deletes the sync object specified by <em class="parameter"><code>sync</code></em>. If the fence command
corresponding to the specified sync object has completed, or if no <a class="citerefentry" href="glWaitSync"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>
or <a class="citerefentry" href="glClientWaitSync"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> commands are blocking on <em class="parameter"><code>sync</code></em>,
the object is deleted immediately. Otherwise, <em class="parameter"><code>sync</code></em> is flagged for deletion and will be deleted when
it is no longer associated with any fence command and is no longer blocking any <a class="citerefentry" href="glWaitSync"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>
or <a class="citerefentry" href="glClientWaitSync"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> command. In either case, after
<code class="function">glDeleteSync</code> returns, the name <em class="parameter"><code>sync</code></em> is invalid and can no longer be used to
refer to the sync object.
</p><p>
<code class="function">glDeleteSync</code> will silently ignore a <em class="parameter"><code>sync</code></em> value of zero.
</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
<code class="function">glSync</code> is only supported if the GL version is 3.2 or greater, or if
the <code class="code">ARB_sync</code> extension is supported.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>sync</code></em> is neither zero or the name of a sync object.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glFenceSync"><span class="citerefentry"><span class="refentrytitle">glFenceSync</span></span></a>,
<a class="citerefentry" href="glWaitSync"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>,
<a class="citerefentry" href="glClientWaitSync"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a>
</p></div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2010 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p></div></div></div>