1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroyImage"> 2 <info> 3 <copyright> 4 <year>2018</year> 5 <holder>The Khronos Group Inc.</holder> 6 </copyright> 7 </info> 8 <refmeta> 9 <refentrytitle>eglDestroyImage</refentrytitle> 10 <manvolnum>3G</manvolnum> 11 </refmeta> 12 <refnamediv> 13 <refname>eglDestroyImage</refname> 14 <refpurpose> 15 Destroy an <type>EGLImage</type> object 16 </refpurpose> 17 </refnamediv> 18 <refsynopsisdiv> 19 <title>C Specification</title> 20 <funcsynopsis> 21 <funcprototype> 22 <funcdef>EGLBoolean <function>eglDestroyImage</function></funcdef> 23 <paramdef>(EGLDisplay <parameter>display</parameter></paramdef> 24 <paramdef>EGLImage <parameter>image</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>image</parameter></term> 38 <listitem><para> 39 Specifies the image to destroy. 40 </para></listitem> 41 </varlistentry> 42 </variablelist> 43 </refsect1> 44 <refsect1 xml:id="description"><title>Description</title> 45 <para> 46 <function>eglDestroyImage</function> is used to destroy the 47 specified <type>EGLImage</type> object 48 <parameter>image</parameter>. Once destroyed, 49 <parameter>image</parameter> may not be used to create any 50 additional <type>EGLImage</type> target resources within any 51 client API contexts, although existing <type>EGLImage</type> 52 siblings may continue to be used. <constant>EGL_TRUE</constant> 53 is returned on success. 54 </para> 55 </refsect1> 56 <refsect1 xml:id="errors"><title>Errors</title> 57 <para> 58 On failure, <function>eglDestroyImage</function> returns 59 <constant>EGL_FALSE</constant> 60 </para> 61 <para> 62 If <parameter>display</parameter> is not the handle of a valid 63 <type>EGLDisplay</type> object, the error 64 <constant>EGL_BAD_DISPLAY</constant> is generated. 65 </para> 66 <para> 67 If <parameter>image</parameter> is not a valid 68 <type>EGLImage</type> object created with respect to 69 <parameter>display</parameter>, the error 70 <constant>EGL_BAD_PARAMETER</constant> is generated. 71 </para> 72 </refsect1> 73 <refsect1 xml:id="notes"><title>Notes</title> 74 <para> 75 <function>eglDestroyImage</function> is available only if the 76 EGL version is 1.5 or greater. 77 </para> 78 </refsect1> 79 <refsect1 xml:id="seealso"><title>See Also</title> 80 <para> 81 <citerefentry><refentrytitle>eglCreateImage</refentrytitle></citerefentry> 82 </para> 83 </refsect1> 84 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> 85</refentry> 86