• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroySurface">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglDestroySurface</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglDestroySurface</refname>
14        <refpurpose>
15            destroy an <acronym>EGL</acronym> surface
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLBoolean <function>eglDestroySurface</function></funcdef>
23                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
24                <paramdef>EGLSurface <parameter>surface</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>Specifies the EGL display connection.</para></listitem>
33            </varlistentry>
34            <varlistentry>
35                <term><parameter>surface</parameter></term>
36                <listitem><para>Specifies the EGL surface to be destroyed.
37                </para></listitem>
38            </varlistentry>
39        </variablelist>
40    </refsect1>
41    <refsect1 xml:id="description"><title>Description</title>
42        <para>
43            If the EGL surface <parameter>surface</parameter> is not current to any
44            thread, <function>eglDestroySurface</function> destroys it immediately.
45            Otherwise, <parameter>surface</parameter> is destroyed when it becomes
46            not current to any thread.
47            Furthermore, resources associated with a pbuffer surface are not released until
48            all color buffers of that pbuffer bound to a texture object have been released.
49        </para>
50    </refsect1>
51    <refsect1 xml:id="errors"><title>Errors</title>
52        <para>
53            <constant>EGL_FALSE</constant> is returned if destruction of
54            the surface fails, <constant>EGL_TRUE</constant> otherwise.
55        </para>
56        <para>
57            <constant>EGL_BAD_DISPLAY</constant> is generated if
58            <parameter>display</parameter> is not an EGL display connection.
59        </para>
60        <para>
61            <constant>EGL_NOT_INITIALIZED</constant> is generated if
62            <parameter>display</parameter> has not been initialized.
63        </para>
64        <para>
65            <constant>EGL_BAD_SURFACE</constant> is generated if
66            <parameter>surface</parameter> is not an EGL surface.
67        </para>
68    </refsect1>
69    <refsect1 xml:id="seealso"><title>See Also</title>
70        <para>
71            <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>,
72            <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>,
73            <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>,
74            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>    </para>
75    </refsect1>
76    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
77</refentry>
78