1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <title xmlns:xlink="http://www.w3.org/1999/xlink">eglDestroySync - EGL Reference Pages</title> 5 <link rel="stylesheet" type="text/css" href="khronos-man.css"/> 6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> 7 </head> 8 <body> 9 <header/> 10 <div class="refentry" id="eglDestroySync"> 11 <div class="titlepage"/> 12 <div class="refnamediv"> 13 <h2>Name</h2> 14 <p>eglDestroySync — 15 Destroy a sync object 16 </p> 17 </div> 18 <div class="refsynopsisdiv"> 19 <h2>C Specification</h2> 20 <div class="funcsynopsis"> 21 <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> 22 <tr> 23 <td> 24 <code class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroySync</strong>(</code> 25 </td> 26 <td>(EGLDisplay <var class="pdparam">display</var>, </td> 27 </tr> 28 <tr> 29 <td> </td> 30 <td>EGLSync <var class="pdparam">sync</var><code>)</code>;</td> 31 </tr> 32 </table> 33 <div class="funcprototype-spacer"> </div> 34 </div> 35 </div> 36 <div class="refsect1" id="parameters"> 37 <h2>Parameters</h2> 38 <div class="variablelist"> 39 <dl class="variablelist"> 40 <dt> 41 <span class="term"> 42 <em class="parameter"> 43 <code>display</code> 44 </em> 45 </span> 46 </dt> 47 <dd> 48 <p> 49 Specifies the <abbr class="acronym">EGL</abbr> display connection. 50 </p> 51 </dd> 52 <dt> 53 <span class="term"> 54 <em class="parameter"> 55 <code>sync</code> 56 </em> 57 </span> 58 </dt> 59 <dd> 60 <p> 61 Specifies the sync object to destroy. 62 </p> 63 </dd> 64 </dl> 65 </div> 66 </div> 67 <div class="refsect1" id="description"> 68 <h2>Description</h2> 69 <p> 70 <code class="function">eglDestroySync</code> is used to destroy an 71 existing sync object. 72 </p> 73 <p> 74 If any <code class="function">eglClientWaitSync</code> or 75 <code class="function">eglWaitSync</code> commands are blocking on 76 <em class="parameter"><code>sync</code></em> when 77 <code class="function">eglDestroySync</code> is called, 78 <em class="parameter"><code>sync</code></em> is flagged for deletion and will be 79 deleted when the associated fence command or OpenCL event object 80 has completed, and <em class="parameter"><code>sync</code></em> is no longer 81 blocking any such <code class="function">egl*WaitSync</code> command. 82 Otherwise, the sync object is destroyed immediately. 83 </p> 84 <p> 85 If no errors are generated, <code class="constant">EGL_TRUE</code> is 86 returned, and <em class="parameter"><code>sync</code></em> will no longer be the 87 handle of a valid sync object. 88 </p> 89 </div> 90 <div class="refsect1" id="errors"> 91 <h2>Errors</h2> 92 <p> 93 On failure, <code class="function">eglDestroySync</code> returns 94 <code class="constant">EGL_FALSE</code>. 95 </p> 96 <p> 97 If <em class="parameter"><code>sync</code></em> is not a valid sync object for 98 <em class="parameter"><code>display</code></em>, <code class="constant">EGL_FALSE</code> 99 is returned and an <code class="constant">EGL_BAD_PARAMETER</code> error 100 is generated. 101 </p> 102 <p> 103 If <em class="parameter"><code>display</code></em> does not match the display 104 passed to <code class="function">eglCreateSync</code> when 105 <em class="parameter"><code>sync</code></em> was created, the behaviour is 106 undefined. 107 </p> 108 </div> 109 <div class="refsect1" id="notes"> 110 <h2>Notes</h2> 111 <p> 112 <code class="function">eglDestroySync</code> is available only if the EGL 113 version is 1.5 or greater. 114 </p> 115 </div> 116 <div class="refsect1" id="seealso"> 117 <h2>See Also</h2> 118 <p> 119 <a class="citerefentry" href="eglClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglClientWaitSync</span></span></a>, 120 <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a>, 121 <a class="citerefentry" href="eglWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitSync</span></span></a> 122 </p> 123 </div> 124 <p> 125 </p> 126 <div class="refsect3" id="copyright"> 127 <img src="KhronosLogo.jpg"/> 128 <p> 129 Copyright © 2003-2014 The Khronos Group Inc. 130 Permission is hereby granted, free of charge, to any person obtaining a 131 copy of this software and/or associated documentation files (the 132 "Materials"), to deal in the Materials without restriction, including 133 without limitation the rights to use, copy, modify, merge, publish, 134 distribute, sublicense, and/or sell copies of the Materials, and to 135 permit persons to whom the Materials are furnished to do so, subject to 136 the condition that this copyright notice and permission notice shall be included 137 in all copies or substantial portions of the Materials. 138 </p> 139 </div> 140 <p> 141</p> 142 </div> 143 <footer/> 144 </body> 145</html> 146
