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">eglDestroyImage - 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="eglDestroyImage"> 11 <div class="titlepage"/> 12 <div class="refnamediv"> 13 <h2>Name</h2> 14 <p>eglDestroyImage — 15 Destroy an <span class="type">EGLImage</span> 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">eglDestroyImage</strong>(</code> 25 </td> 26 <td>(EGLDisplay <var class="pdparam">display</var>, </td> 27 </tr> 28 <tr> 29 <td> </td> 30 <td>EGLImage <var class="pdparam">image</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>image</code> 56 </em> 57 </span> 58 </dt> 59 <dd> 60 <p> 61 Specifies the image 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">eglDestroyImage</code> is used to destroy the 71 specified <span class="type">EGLImage</span> object 72 <em class="parameter"><code>image</code></em>. Once destroyed, 73 <em class="parameter"><code>image</code></em> may not be used to create any 74 additional <span class="type">EGLImage</span> target resources within any 75 client API contexts, although existing <span class="type">EGLImage</span> 76 siblings may continue to be used. <code class="constant">EGL_TRUE</code> 77 is returned on success. 78 </p> 79 </div> 80 <div class="refsect1" id="errors"> 81 <h2>Errors</h2> 82 <p> 83 On failure, <code class="function">eglDestroyImage</code> returns 84 <code class="constant">EGL_FALSE</code> 85 </p> 86 <p> 87 If <em class="parameter"><code>display</code></em> is not the handle of a valid 88 <span class="type">EGLDisplay</span> object, the error 89 <code class="constant">EGL_BAD_DISPLAY</code> is generated. 90 </p> 91 <p> 92 If <em class="parameter"><code>image</code></em> is not a valid 93 <span class="type">EGLImage</span> object created with respect to 94 <em class="parameter"><code>display</code></em>, the error 95 <code class="constant">EGL_BAD_PARAMETER</code> is generated. 96 </p> 97 </div> 98 <div class="refsect1" id="notes"> 99 <h2>Notes</h2> 100 <p> 101 <code class="function">eglDestroyImage</code> is available only if the 102 EGL version is 1.5 or greater. 103 </p> 104 </div> 105 <div class="refsect1" id="seealso"> 106 <h2>See Also</h2> 107 <p> 108 <a class="citerefentry" href="eglCreateImage.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateImage</span></span></a> 109 </p> 110 </div> 111 <p> 112 </p> 113 <div class="refsect3" id="copyright"> 114 <img src="KhronosLogo.jpg"/> 115 <p> 116 Copyright © 2003-2014 The Khronos Group Inc. 117 Permission is hereby granted, free of charge, to any person obtaining a 118 copy of this software and/or associated documentation files (the 119 "Materials"), to deal in the Materials without restriction, including 120 without limitation the rights to use, copy, modify, merge, publish, 121 distribute, sublicense, and/or sell copies of the Materials, and to 122 permit persons to whom the Materials are furnished to do so, subject to 123 the condition that this copyright notice and permission notice shall be included 124 in all copies or substantial portions of the Materials. 125 </p> 126 </div> 127 <p> 128</p> 129 </div> 130 <footer/> 131 </body> 132</html> 133
