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