1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroySync"> 2 <info> 3 <copyright> 4 <year>2018</year> 5 <holder>The Khronos Group Inc.</holder> 6 </copyright> 7 </info> 8 <refmeta> 9 <refentrytitle>eglDestroySync</refentrytitle> 10 <manvolnum>3G</manvolnum> 11 </refmeta> 12 <refnamediv> 13 <refname>eglDestroySync</refname> 14 <refpurpose> 15 Destroy a sync object 16 </refpurpose> 17 </refnamediv> 18 <refsynopsisdiv> 19 <title>C Specification</title> 20 <funcsynopsis> 21 <funcprototype> 22 <funcdef>EGLBoolean <function>eglDestroySync</function></funcdef> 23 <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> 24 <paramdef>EGLSync <parameter>sync</parameter></paramdef> 25 </funcprototype> 26 </funcsynopsis> 27 </refsynopsisdiv> 28 <refsect1 xml:id="parameters"><title>Parameters</title> 29 <variablelist> 30 <varlistentry> 31 <term><parameter>display</parameter></term> 32 <listitem><para> 33 Specifies the <acronym>EGL</acronym> display connection. 34 </para></listitem> 35 </varlistentry> 36 <varlistentry> 37 <term><parameter>sync</parameter></term> 38 <listitem><para> 39 Specifies the sync object to destroy. 40 </para></listitem> 41 </varlistentry> 42 </variablelist> 43 </refsect1> 44 <refsect1 xml:id="description"><title>Description</title> 45 <para> 46 <function>eglDestroySync</function> is used to destroy an 47 existing sync object. 48 </para> 49 <para> 50 If any <function>eglClientWaitSync</function> or 51 <function>eglWaitSync</function> commands are blocking on 52 <parameter>sync</parameter> when 53 <function>eglDestroySync</function> is called, 54 <parameter>sync</parameter> is flagged for deletion and will be 55 deleted when the associated fence command or OpenCL event object 56 has completed, and <parameter>sync</parameter> is no longer 57 blocking any such <function>egl*WaitSync</function> command. 58 Otherwise, the sync object is destroyed immediately. 59 </para> 60 <para> 61 If no errors are generated, <constant>EGL_TRUE</constant> is 62 returned, and <parameter>sync</parameter> will no longer be the 63 handle of a valid sync object. 64 </para> 65 </refsect1> 66 <refsect1 xml:id="errors"><title>Errors</title> 67 <para> 68 On failure, <function>eglDestroySync</function> returns 69 <constant>EGL_FALSE</constant>. 70 </para> 71 <para> 72 If <parameter>sync</parameter> is not a valid sync object for 73 <parameter>display</parameter>, <constant>EGL_FALSE</constant> 74 is returned and an <constant>EGL_BAD_PARAMETER</constant> error 75 is generated. 76 </para> 77 <para> 78 If <parameter>display</parameter> does not match the display 79 passed to <function>eglCreateSync</function> when 80 <parameter>sync</parameter> was created, the behaviour is 81 undefined. 82 </para> 83 </refsect1> 84 <refsect1 xml:id="notes"><title>Notes</title> 85 <para> 86 <function>eglDestroySync</function> is available only if the EGL 87 version is 1.5 or greater. 88 </para> 89 </refsect1> 90 <refsect1 xml:id="seealso"><title>See Also</title> 91 <para> 92 <citerefentry><refentrytitle>eglClientWaitSync</refentrytitle></citerefentry>, 93 <citerefentry><refentrytitle>eglCreateSync</refentrytitle></citerefentry>, 94 <citerefentry><refentrytitle>eglWaitSync</refentrytitle></citerefentry> 95 </para> 96 </refsect1> 97 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> 98</refentry> 99