Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> | |
4 | <refentry id="glDeleteSync"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>2010</year> | |
9 | <holder>Khronos Group</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glDeleteSync</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glDeleteSync</refname> | |
17 | <refpurpose>delete a sync object</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glDeleteSync</function></funcdef> | |
23 | <paramdef>GLsync <parameter>sync</parameter></paramdef> | |
24 | </funcprototype> | |
25 | </funcsynopsis> | |
26 | </refsynopsisdiv> | |
27 | <!-- eqn: ignoring delim $$ --> | |
28 | <refsect1 id="parameters"><title>Parameters</title> | |
29 | <variablelist> | |
30 | <varlistentry> | |
31 | <term><parameter>sync</parameter></term> | |
32 | <listitem> | |
33 | <para> | |
34 | The sync object to be deleted. | |
35 | </para> | |
36 | </listitem> | |
37 | </varlistentry> | |
38 | </variablelist> | |
39 | </refsect1> | |
40 | <refsect1 id="description"><title>Description</title> | |
41 | <para> | |
42 | <function>glDeleteSync</function> deletes the sync object specified by <parameter>sync</parameter>. If the fence command | |
43 | corresponding to the specified sync object has completed, or if no <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry> | |
44 | or <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry> commands are blocking on <parameter>sync</parameter>, | |
45 | the object is deleted immediately. Otherwise, <parameter>sync</parameter> is flagged for deletion and will be deleted when | |
46 | it is no longer associated with any fence command and is no longer blocking any <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry> | |
47 | or <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry> command. In either case, after | |
48 | <function>glDeleteSync</function> returns, the name <parameter>sync</parameter> is invalid and can no longer be used to | |
49 | refer to the sync object. | |
50 | </para> | |
51 | <para> | |
52 | <function>glDeleteSync</function> will silently ignore a <parameter>sync</parameter> value of zero. | |
53 | </para> | |
54 | </refsect1> | |
55 | <refsect1 id="notes"><title>Notes</title> | |
56 | <para> | |
57 | <function>glSync</function> is only supported if the GL version is 3.2 or greater, or if | |
58 | the <code>ARB_sync</code> extension is supported. | |
59 | </para> | |
60 | </refsect1> | |
61 | <refsect1 id="errors"><title>Errors</title> | |
62 | <para> | |
63 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>sync</parameter> is neither zero or the name of a sync object. | |
64 | </para> | |
65 | </refsect1> | |
66 | <refsect1 id="seealso"><title>See Also</title> | |
67 | <para> | |
68 | <citerefentry><refentrytitle>glFenceSync</refentrytitle></citerefentry>, | |
69 | <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry>, | |
70 | <citerefentry><refentrytitle>glClientWaitSync</refentrytitle></citerefentry> | |
71 | </para> | |
72 | </refsect1> | |
73 | <refsect1 id="Copyright"><title>Copyright</title> | |
74 | <para> | |
75 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. | |
76 | This material may be distributed subject to the terms and conditions set forth in | |
77 | the Open Publication License, v 1.0, 8 June 1999. | |
78 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
79 | </para> | |
80 | </refsect1> | |
81 | </refentry> |