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="eglInitialize">
5    <refentryinfo>
6         <copyright>
7             <year>2003-2014</year>
8             <holder>The Khronos Group Inc.</holder>
9         </copyright>
10    </refentryinfo>
11    <refmeta>
12        <refentrytitle>eglInitialize</refentrytitle>
13        <manvolnum>3G</manvolnum>
14    </refmeta>
15    <refnamediv>
16        <refname>eglInitialize</refname>
17        <refpurpose>
18            initialize an <acronym>EGL</acronym> display connection
19        </refpurpose>
20    </refnamediv>
21    <refsynopsisdiv>
22        <title>C Specification</title>
23        <funcsynopsis>
24            <funcprototype>
25                <funcdef>EGLBoolean <function>eglInitialize</function></funcdef>
26                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
27                <paramdef>EGLint * <parameter>major</parameter></paramdef>
28                <paramdef>EGLint * <parameter>minor</parameter></paramdef>
29            </funcprototype>
30        </funcsynopsis>
31    </refsynopsisdiv>
32    <refsect1 id="parameters"><title>Parameters</title>
33        <variablelist>
34            <varlistentry>
35                <term><parameter>display</parameter></term>
36                <listitem>
37                    <para>
38                        Specifies the EGL display connection to initialize.
39                    </para>
40                </listitem>
41            </varlistentry>
42            <varlistentry>
43                <term><parameter>major</parameter></term>
44                <listitem>
45                    <para>
46                        Returns the major version number of the EGL implementation.
47                        May be <constant>NULL</constant>.
48                    </para>
49                </listitem>
50            </varlistentry>
51            <varlistentry>
52                <term><parameter>minor</parameter></term>
53                <listitem>
54                    <para>
55                        Returns the minor version number of the EGL implementation.
56                        May be <constant>NULL</constant>.
57                    </para>
58                </listitem>
59            </varlistentry>
60        </variablelist>
61    </refsect1>
62    <refsect1 id="description"><title>Description</title>
63        <para>
64            <function>eglInitialize</function> initialized the EGL display
65            connection obtained with
66            <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>.
67            Initializing an already initialized EGL display connection has no
68            effect besides returning the version numbers.
69        </para>
70        <para>
71            <parameter>major</parameter> and <parameter>minor</parameter>
72            do not return values if they are specified as <constant>NULL</constant>.
73        </para>
74        <para>
75            Use <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry>
76            to release resources associated with an EGL display connection.
77        </para>
78    </refsect1>
79    <refsect1 id="errors"><title>Errors</title>
80        <para>
81            <constant>EGL_FALSE</constant> is returned if
82            <function>eglInitialize</function> fails,
83            <constant>EGL_TRUE</constant> otherwise.
84            <parameter>major</parameter> and <parameter>minor</parameter> are not
85            modified when <constant>EGL_FALSE</constant> is returned.
86        </para>
87        <para>
88            <constant>EGL_BAD_DISPLAY</constant> is generated if
89            <parameter>display</parameter> is not an EGL display connection.
90        </para>
91        <para>
92            <constant>EGL_NOT_INITIALIZED</constant> is generated if
93            <parameter>display</parameter> cannot be initialized.
94        </para>
95    </refsect1>
96    <refsect1 id="seealso"><title>See Also</title>
97        <para>
98            <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>,
99            <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry>
100        </para>
101    </refsect1>
102    <refsect3 id="Copyright"><title></title>
103        <!-- Content included from copyright.inc.xsl -->
104        <imageobject>
105                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
106        </imageobject>
107        <para />
108    </refsect3>
109</refentry>
110