• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3                            "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4<refentry xml:base="" id="eglDestroySurface">
5    <refentryinfo>
6         <copyright>
7             <year>2003-2014</year>
8             <holder>The Khronos Group Inc.</holder>
9         </copyright>
10    </refentryinfo>
11    <refmeta>
12        <refentrytitle>eglDestroySurface</refentrytitle>
13        <manvolnum>3G</manvolnum>
14    </refmeta>
15    <refnamediv>
16        <refname>eglDestroySurface</refname>
17        <refpurpose>
18            destroy an <acronym>EGL</acronym> surface
19        </refpurpose>
20    </refnamediv>
21    <refsynopsisdiv>
22        <title>C Specification</title>
23        <funcsynopsis>
24            <funcprototype>
25                <funcdef>EGLBoolean <function>eglDestroySurface</function></funcdef>
26                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
27                <paramdef>EGLSurface <parameter>surface</parameter></paramdef>
28            </funcprototype>
29        </funcsynopsis>
30    </refsynopsisdiv>
31    <refsect1 id="parameters"><title>Parameters</title>
32        <variablelist>
33            <varlistentry>
34                <term><parameter>display</parameter></term>
35                <listitem><para>Specifies the EGL display connection.</para></listitem>
36            </varlistentry>
37            <varlistentry>
38                <term><parameter>surface</parameter></term>
39                <listitem><para>Specifies the EGL surface to be destroyed.
40                </para></listitem>
41            </varlistentry>
42        </variablelist>
43    </refsect1>
44    <refsect1 id="description"><title>Description</title>
45        <para>
46            If the EGL surface <parameter>surface</parameter> is not current to any
47            thread, <function>eglDestroySurface</function> destroys it immediately.
48            Otherwise, <parameter>surface</parameter> is destroyed when it becomes
49            not current to any thread.
50            Furthermore, resources associated with a pbuffer surface are not released until
51            all color buffers of that pbuffer bound to a texture object have been released.
52        </para>
53    </refsect1>
54    <refsect1 id="errors"><title>Errors</title>
55        <para>
56            <constant>EGL_FALSE</constant> is returned if destruction of
57            the surface fails, <constant>EGL_TRUE</constant> otherwise.
58        </para>
59        <para>
60            <constant>EGL_BAD_DISPLAY</constant> is generated if
61            <parameter>display</parameter> is not an EGL display connection.
62        </para>
63        <para>
64            <constant>EGL_NOT_INITIALIZED</constant> is generated if
65            <parameter>display</parameter> has not been initialized.
66        </para>
67        <para>
68            <constant>EGL_BAD_SURFACE</constant> is generated if
69            <parameter>surface</parameter> is not an EGL surface.
70        </para>
71    </refsect1>
72    <refsect1 id="seealso"><title>See Also</title>
73        <para>
74            <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>,
75            <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>,
76            <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>,
77            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>    </para>
78    </refsect1>
79    <refsect3 id="Copyright"><title></title>
80        <!-- Content included from copyright.inc.xsl -->
81        <imageobject>
82                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
83        </imageobject>
84        <para />
85    </refsect3>
86</refentry>
87