upstream-man-pages/man3/xhtml/glDeleteSync.xml

   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>glDeleteSync</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glDeleteSync"><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" 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">glDeleteSync</b>(</code></td><td>GLsync <var class="pdparam">sync</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                     The sync object to be deleted.
   6                 </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
   7             <code class="function">glDeleteSync</code> deletes the sync object specified by <em class="parameter"><code>sync</code></em>. If the fence command
   8             corresponding to the specified sync object has completed, or if no <a class="citerefentry" href="glWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>
   9             or <a class="citerefentry" href="glClientWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> commands are blocking on <em class="parameter"><code>sync</code></em>,
  10             the object is deleted immediately. Otherwise, <em class="parameter"><code>sync</code></em> is flagged for deletion and will be deleted when
  11             it is no longer associated with any fence command and is no longer blocking any <a class="citerefentry" href="glWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>
  12             or <a class="citerefentry" href="glClientWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a> command. In either case, after
  13             <code class="function">glDeleteSync</code> returns, the name <em class="parameter"><code>sync</code></em> is invalid and can no longer be used to
  14             refer to the sync object.
  15         </p><p>
  16             <code class="function">glDeleteSync</code> will silently ignore a <em class="parameter"><code>sync</code></em> value of zero.
  17         </p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>
  18             <code class="function">glSync</code> is only supported if the GL version is 3.2 or greater, or if
  19             the <code class="code">ARB_sync</code> extension is supported.
  20         </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p>
  21             <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.
  22         </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
  23             <a class="citerefentry" href="glFenceSync.xml"><span class="citerefentry"><span class="refentrytitle">glFenceSync</span></span></a>,
  24             <a class="citerefentry" href="glWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a>,
  25             <a class="citerefentry" href="glClientWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glClientWaitSync</span></span></a>
  26         </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
  27             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  28             This material may be distributed subject to the terms and conditions set forth in
  29             the Open Publication License, v 1.0, 8 June 1999.
  30             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  31         </p></div></div></body></html>