• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglDestroyContext">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglDestroyContext</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglDestroyContext</refname>
14        <refpurpose>
15            destroy an <acronym>EGL</acronym> rendering context
16        </refpurpose>
17    </refnamediv>
18    <refsynopsisdiv>
19        <title>C Specification</title>
20        <funcsynopsis>
21            <funcprototype>
22                <funcdef>EGLBoolean <function>eglDestroyContext</function></funcdef>
23                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
24                <paramdef>EGLContext <parameter>context</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>context</parameter></term>
36                <listitem><para>Specifies the EGL rendering context 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 rendering context <parameter>context</parameter> is not
44            current to any thread,
45            <function>eglDestroyContext</function> destroys it immediately.
46            Otherwise, <parameter>context</parameter> is destroyed when it becomes
47            not current to any thread.
48        </para>
49    </refsect1>
50    <refsect1 xml:id="errors"><title>Errors</title>
51        <para>
52            <constant>EGL_FALSE</constant> is returned if destruction of
53            the context fails, <constant>EGL_TRUE</constant> otherwise.
54        </para>
55        <para>
56            <constant>EGL_BAD_DISPLAY</constant> is generated if
57            <parameter>display</parameter> is not an EGL display connection.
58        </para>
59        <para>
60            <constant>EGL_NOT_INITIALIZED</constant> is generated if
61            <parameter>display</parameter> has not been initialized.
62        </para>
63        <para>
64            <constant>EGL_BAD_CONTEXT</constant> is generated if
65            <parameter>context</parameter> is not an EGL rendering context.
66        </para>
67    </refsect1>
68    <refsect1 xml:id="seealso"><title>See Also</title>
69        <para>
70            <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>,
71            <citerefentry><refentrytitle>eglMakeCurrent</refentrytitle></citerefentry>
72        </para>
73    </refsect1>
74    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
75</refentry>
76