• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglInitialize">
2    <info>
3         <copyright>
4             <year>2003-2014</year>
5             <holder>The Khronos Group Inc.</holder>
6         </copyright>
7    </info>
8    <refmeta>
9        <refentrytitle>eglInitialize</refentrytitle>
10        <manvolnum>3G</manvolnum>
11    </refmeta>
12    <refnamediv>
13        <refname>eglInitialize</refname>
14        <refpurpose>
15            initialize 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>eglInitialize</function></funcdef>
23                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
24                <paramdef>EGLint * <parameter>major</parameter></paramdef>
25                <paramdef>EGLint * <parameter>minor</parameter></paramdef>
26            </funcprototype>
27        </funcsynopsis>
28    </refsynopsisdiv>
29    <refsect1 xml:id="parameters"><title>Parameters</title>
30        <variablelist>
31            <varlistentry>
32                <term><parameter>display</parameter></term>
33                <listitem>
34                    <para>
35                        Specifies the EGL display connection to initialize.
36                    </para>
37                </listitem>
38            </varlistentry>
39            <varlistentry>
40                <term><parameter>major</parameter></term>
41                <listitem>
42                    <para>
43                        Returns the major version number of the EGL implementation.
44                        May be <constant>NULL</constant>.
45                    </para>
46                </listitem>
47            </varlistentry>
48            <varlistentry>
49                <term><parameter>minor</parameter></term>
50                <listitem>
51                    <para>
52                        Returns the minor version number of the EGL implementation.
53                        May be <constant>NULL</constant>.
54                    </para>
55                </listitem>
56            </varlistentry>
57        </variablelist>
58    </refsect1>
59    <refsect1 xml:id="description"><title>Description</title>
60        <para>
61            <function>eglInitialize</function> initialized the EGL display
62            connection obtained with
63            <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>.
64            Initializing an already initialized EGL display connection has no
65            effect besides returning the version numbers.
66        </para>
67        <para>
68            <parameter>major</parameter> and <parameter>minor</parameter>
69            do not return values if they are specified as <constant>NULL</constant>.
70        </para>
71        <para>
72            Use <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry>
73            to release resources associated with an EGL display connection.
74        </para>
75    </refsect1>
76    <refsect1 xml:id="errors"><title>Errors</title>
77        <para>
78            <constant>EGL_FALSE</constant> is returned if
79            <function>eglInitialize</function> fails,
80            <constant>EGL_TRUE</constant> otherwise.
81            <parameter>major</parameter> and <parameter>minor</parameter> are not
82            modified when <constant>EGL_FALSE</constant> is returned.
83        </para>
84        <para>
85            <constant>EGL_BAD_DISPLAY</constant> is generated if
86            <parameter>display</parameter> is not an EGL display connection.
87        </para>
88        <para>
89            <constant>EGL_NOT_INITIALIZED</constant> is generated if
90            <parameter>display</parameter> cannot be initialized.
91        </para>
92    </refsect1>
93    <refsect1 xml:id="seealso"><title>See Also</title>
94        <para>
95            <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>,
96            <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry>
97        </para>
98    </refsect1>
99    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
100</refentry>
101