2013-10-10 23:58:54 +00:00
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
|
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
|
|
|
<refentry id="glDeleteSync">
|
|
|
|
|
<refmeta>
|
|
|
|
|
<refmetainfo>
|
|
|
|
|
<copyright>
|
|
|
|
|
<year>2010</year>
|
|
|
|
|
<holder>Khronos Group</holder>
|
|
|
|
|
</copyright>
|
|
|
|
|
</refmetainfo>
|
|
|
|
|
<refentrytitle>glDeleteSync</refentrytitle>
|
|
|
|
|
<manvolnum>3G</manvolnum>
|
|
|
|
|
</refmeta>
|
|
|
|
|
<refnamediv>
|
|
|
|
|
<refname>glDeleteSync</refname>
|
|
|
|
|
<refpurpose>delete a sync object</refpurpose>
|
|
|
|
|
</refnamediv>
|
|
|
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
|
|
|
<funcsynopsis>
|
|
|
|
|
<funcprototype>
|
|
|
|
|
<funcdef>void <function>glDeleteSync</function></funcdef>
|
|
|
|
|
<paramdef>GLsync <parameter>sync</parameter></paramdef>
|
|
|
|
|
</funcprototype>
|
|
|
|
|
</funcsynopsis>
|
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
<!-- eqn: ignoring delim $$ -->
|
|
|
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
|
|
|
<variablelist>
|
|
|
|
|
<varlistentry>
|
|
|
|
|
<term><parameter>sync</parameter></term>
|
|
|
|
|
<listitem>
|
|
|
|
|
<para>
|
|
|
|
|
The sync object to be deleted.
|
|
|
|
|
</para>
|
|
|
|
|
</listitem>
|
|
|
|
|
</varlistentry>
|
|
|
|
|
</variablelist>
|
|
|
|
|
</refsect1>
|
|
|
|
|
<refsect1 id="description"><title>Description</title>
|
|
|
|
|
<para>
|
|
|
|
|
<function>glDeleteSync</function> deletes the sync object specified by <parameter>sync</parameter>. If the fence command
|
|
|
|
|
corresponding to the specified sync object has completed, or if no <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>
|
|
|
|
|
or <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry> commands are blocking on <parameter>sync</parameter>,
|
|
|
|
|
the object is deleted immediately. Otherwise, <parameter>sync</parameter> is flagged for deletion and will be deleted when
|
|
|
|
|
it is no longer associated with any fence command and is no longer blocking any <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>
|
|
|
|
|
or <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry> command. In either case, after
|
|
|
|
|
<function>glDeleteSync</function> returns, the name <parameter>sync</parameter> is invalid and can no longer be used to
|
|
|
|
|
refer to the sync object.
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
<function>glDeleteSync</function> will silently ignore a <parameter>sync</parameter> value of zero.
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
<refsect1 id="notes"><title>Notes</title>
|
|
|
|
|
<para>
|
|
|
|
|
<function>glSync</function> is only supported if the GL version is 3.2 or greater, or if
|
|
|
|
|
the <code>ARB_sync</code> extension is supported.
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
|
|
|
<para>
|
|
|
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>sync</parameter> is neither zero or the name of a sync object.
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
|
|
|
<para>
|
|
|
|
|
<citerefentry><refentrytitle>glFenceSync</refentrytitle></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>,
|
|
|
|
|
<citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry>
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
|
|
|
<para>
|
|
|
|
|
Copyright <trademark class="copyright"></trademark> 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.
|
|
|
|
|
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
|
|
|
|
|
</para>
|
|
|
|
|
</refsect1>
|
|
|
|
|
</refentry>
|
