• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <title xmlns:xlink="http://www.w3.org/1999/xlink">eglInitialize - EGL Reference Pages</title>
5    <link rel="stylesheet" type="text/css" href="khronos-man.css"/>
6    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"/>
7  </head>
8  <body>
9    <header/>
10    <div class="refentry" id="eglInitialize">
11      <div class="titlepage"/>
12      <div class="refnamediv">
13        <h2>Name</h2>
14        <p>eglInitialize —
15            initialize an <abbr class="acronym">EGL</abbr> display connection
16        </p>
17      </div>
18      <div class="refsynopsisdiv">
19        <h2>C Specification</h2>
20        <div class="funcsynopsis">
21          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
22            <tr>
23              <td>
24                <code class="funcdef">EGLBoolean <strong class="fsfunc">eglInitialize</strong>(</code>
25              </td>
26              <td>EGLDisplay <var class="pdparam">display</var>, </td>
27            </tr>
28            <tr>
29              <td> </td>
30              <td>EGLint * <var class="pdparam">major</var>, </td>
31            </tr>
32            <tr>
33              <td> </td>
34              <td>EGLint * <var class="pdparam">minor</var><code>)</code>;</td>
35            </tr>
36          </table>
37          <div class="funcprototype-spacer"> </div>
38        </div>
39      </div>
40      <div class="refsect1" id="parameters">
41        <h2>Parameters</h2>
42        <div class="variablelist">
43          <dl class="variablelist">
44            <dt>
45              <span class="term">
46                <em class="parameter">
47                  <code>display</code>
48                </em>
49              </span>
50            </dt>
51            <dd>
52              <p>
53                        Specifies the EGL display connection to initialize.
54                    </p>
55            </dd>
56            <dt>
57              <span class="term">
58                <em class="parameter">
59                  <code>major</code>
60                </em>
61              </span>
62            </dt>
63            <dd>
64              <p>
65                        Returns the major version number of the EGL implementation.
66                        May be <code class="constant">NULL</code>.
67                    </p>
68            </dd>
69            <dt>
70              <span class="term">
71                <em class="parameter">
72                  <code>minor</code>
73                </em>
74              </span>
75            </dt>
76            <dd>
77              <p>
78                        Returns the minor version number of the EGL implementation.
79                        May be <code class="constant">NULL</code>.
80                    </p>
81            </dd>
82          </dl>
83        </div>
84      </div>
85      <div class="refsect1" id="description">
86        <h2>Description</h2>
87        <p>
88            <code class="function">eglInitialize</code> initialized the EGL display
89            connection obtained with
90            <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>.
91            Initializing an already initialized EGL display connection has no
92            effect besides returning the version numbers.
93        </p>
94        <p>
95            <em class="parameter"><code>major</code></em> and <em class="parameter"><code>minor</code></em>
96            do not return values if they are specified as <code class="constant">NULL</code>.
97        </p>
98        <p>
99            Use <a class="citerefentry" href="eglTerminate.xhtml"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a>
100            to release resources associated with an EGL display connection.
101        </p>
102      </div>
103      <div class="refsect1" id="errors">
104        <h2>Errors</h2>
105        <p>
106            <code class="constant">EGL_FALSE</code> is returned if
107            <code class="function">eglInitialize</code> fails,
108            <code class="constant">EGL_TRUE</code> otherwise.
109            <em class="parameter"><code>major</code></em> and <em class="parameter"><code>minor</code></em> are not
110            modified when <code class="constant">EGL_FALSE</code> is returned.
111        </p>
112        <p>
113            <code class="constant">EGL_BAD_DISPLAY</code> is generated if
114            <em class="parameter"><code>display</code></em> is not an EGL display connection.
115        </p>
116        <p>
117            <code class="constant">EGL_NOT_INITIALIZED</code> is generated if
118            <em class="parameter"><code>display</code></em> cannot be initialized.
119        </p>
120      </div>
121      <div class="refsect1" id="seealso">
122        <h2>See Also</h2>
123        <p>
124            <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a>,
125            <a class="citerefentry" href="eglTerminate.xhtml"><span class="citerefentry"><span class="refentrytitle">eglTerminate</span></span></a>
126        </p>
127      </div>
128      <p>
129    </p>
130      <div class="refsect3" id="copyright">
131        <img src="KhronosLogo.jpg"/>
132        <p>
133            Copyright © 2003-2014 The Khronos Group Inc.
134            Permission is hereby granted, free of charge, to any person obtaining a
135            copy of this software and/or associated documentation files (the
136            "Materials"), to deal in the Materials without restriction, including
137            without limitation the rights to use, copy, modify, merge, publish,
138            distribute, sublicense, and/or sell copies of the Materials, and to
139            permit persons to whom the Materials are furnished to do so, subject to
140            the condition that this copyright notice and permission notice shall be included
141            in all copies or substantial portions of the Materials.
142        </p>
143      </div>
144      <p>
145</p>
146    </div>
147    <footer/>
148  </body>
149</html>
150