• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglTerminate">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglTerminate</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglTerminate</refname>
14        <refpurpose>
15            terminate an <acronym>EGL</acronym> display connection
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLBoolean <function>eglTerminate</function></funcdef>
23                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
24            </funcprototype>
25        </funcsynopsis>
26    </refsynopsisdiv>
27    <refsect1 xml:id="parameters"><title>Parameters</title>
28        <variablelist>
29            <varlistentry>
30                <term><parameter>display</parameter></term>
31                <listitem>
32                    <para>
33                        Specifies the EGL display connection to terminate.
34                    </para>
35                </listitem>
36            </varlistentry>
37        </variablelist>
38    </refsect1>
39    <refsect1 xml:id="description"><title>Description</title>
40        <para>
41            <function>eglTerminate</function> releases resources associated with
42            an EGL display connection. Termination marks all EGL resources associated
43            with the EGL display connection for deletion. If contexts or surfaces
44            associated with <parameter>display</parameter> is current to any thread,
45            they are not released until they are no longer current as a result of
46            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>.
47        </para>
48        <para>
49            Terminating an already terminated EGL display connection has no effect.
50            A terminated display may be re-initialized by calling
51            <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>
52            again.
53        </para>
54    </refsect1>
55    <refsect1 xml:id="errors"><title>Errors</title>
56        <para>
57            <constant>EGL_FALSE</constant> is returned if
58            <function>eglTerminate</function> fails,
59            <constant>EGL_TRUE</constant> otherwise.
60        </para>
61        <para>
62            <constant>EGL_BAD_DISPLAY</constant> is generated if
63            <parameter>display</parameter> is not an EGL display connection.
64        </para>
65    </refsect1>
66    <refsect1 xml:id="seealso"><title>See Also</title>
67        <para>
68            <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>,
69            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>
70        </para>
71    </refsect1>
72    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
73</refentry>
74