diff options
Diffstat (limited to 'glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml')
| -rw-r--r-- | glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml new file mode 100644 index 0000000..7db22eb --- /dev/null +++ b/glew/auto/EGL-Registry/sdk/docs/man/html/eglDestroySync.xhtml @@ -0,0 +1,145 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <title xmlns:xlink="http://www.w3.org/1999/xlink">eglDestroySync - EGL Reference Pages</title> + <link rel="stylesheet" type="text/css" href="khronos-man.css"/> + <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/> + </head> + <body> + <header/> + <div class="refentry" id="eglDestroySync"> + <div class="titlepage"/> + <div class="refnamediv"> + <h2>Name</h2> + <p>eglDestroySync — + Destroy a sync object + </p> + </div> + <div class="refsynopsisdiv"> + <h2>C Specification</h2> + <div class="funcsynopsis"> + <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> + <tr> + <td> + <code class="funcdef">EGLBoolean <strong class="fsfunc">eglDestroySync</strong>(</code> + </td> + <td>(EGLDisplay <var class="pdparam">display</var>, </td> + </tr> + <tr> + <td> </td> + <td>EGLSync <var class="pdparam">sync</var><code>)</code>;</td> + </tr> + </table> + <div class="funcprototype-spacer"> </div> + </div> + </div> + <div class="refsect1" id="parameters"> + <h2>Parameters</h2> + <div class="variablelist"> + <dl class="variablelist"> + <dt> + <span class="term"> + <em class="parameter"> + <code>display</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the <abbr class="acronym">EGL</abbr> display connection. + </p> + </dd> + <dt> + <span class="term"> + <em class="parameter"> + <code>sync</code> + </em> + </span> + </dt> + <dd> + <p> + Specifies the sync object to destroy. + </p> + </dd> + </dl> + </div> + </div> + <div class="refsect1" id="description"> + <h2>Description</h2> + <p> + <code class="function">eglDestroySync</code> is used to destroy an + existing sync object. + </p> + <p> + If any <code class="function">eglClientWaitSync</code> or + <code class="function">eglWaitSync</code> commands are blocking on + <em class="parameter"><code>sync</code></em> when + <code class="function">eglDestroySync</code> is called, + <em class="parameter"><code>sync</code></em> is flagged for deletion and will be + deleted when the associated fence command or OpenCL event object + has completed, and <em class="parameter"><code>sync</code></em> is no longer + blocking any such <code class="function">egl*WaitSync</code> command. + Otherwise, the sync object is destroyed immediately. + </p> + <p> + If no errors are generated, <code class="constant">EGL_TRUE</code> is + returned, and <em class="parameter"><code>sync</code></em> will no longer be the + handle of a valid sync object. + </p> + </div> + <div class="refsect1" id="errors"> + <h2>Errors</h2> + <p> + On failure, <code class="function">eglDestroySync</code> returns + <code class="constant">EGL_FALSE</code>. + </p> + <p> + If <em class="parameter"><code>sync</code></em> is not a valid sync object for + <em class="parameter"><code>display</code></em>, <code class="constant">EGL_FALSE</code> + is returned and an <code class="constant">EGL_BAD_PARAMETER</code> error + is generated. + </p> + <p> + If <em class="parameter"><code>display</code></em> does not match the display + passed to <code class="function">eglCreateSync</code> when + <em class="parameter"><code>sync</code></em> was created, the behaviour is + undefined. + </p> + </div> + <div class="refsect1" id="notes"> + <h2>Notes</h2> + <p> + <code class="function">eglDestroySync</code> is available only if the EGL + version is 1.5 or greater. + </p> + </div> + <div class="refsect1" id="seealso"> + <h2>See Also</h2> + <p> + <a class="citerefentry" href="eglClientWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglClientWaitSync</span></span></a>, + <a class="citerefentry" href="eglCreateSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateSync</span></span></a>, + <a class="citerefentry" href="eglWaitSync.xhtml"><span class="citerefentry"><span class="refentrytitle">eglWaitSync</span></span></a> + </p> + </div> + <p> + </p> + <div class="refsect3" id="copyright"> + <img src="KhronosLogo.jpg"/> + <p> + Copyright © 2003-2014 The Khronos Group Inc. + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and/or associated documentation files (the + "Materials"), to deal in the Materials without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Materials, and to + permit persons to whom the Materials are furnished to do so, subject to + the condition that this copyright notice and permission notice shall be included + in all copies or substantial portions of the Materials. + </p> + </div> + <p> +</p> + </div> + <footer/> + </body> +</html> |