• 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">eglGetDisplay - 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="eglGetDisplay">
11      <div class="titlepage"/>
12      <div class="refnamediv">
13        <h2>Name</h2>
14        <p>eglGetDisplay —
15            return 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">EGLDisplay <strong class="fsfunc">eglGetDisplay</strong>(</code>
25              </td>
26              <td>NativeDisplayType <var class="pdparam">native_display</var><code>)</code>;</td>
27            </tr>
28          </table>
29          <div class="funcprototype-spacer"> </div>
30        </div>
31      </div>
32      <div class="refsect1" id="parameters">
33        <h2>Parameters</h2>
34        <div class="variablelist">
35          <dl class="variablelist">
36            <dt>
37              <span class="term">
38                <em class="parameter">
39                  <code>native_display</code>
40                </em>
41              </span>
42            </dt>
43            <dd>
44              <p>
45                        Specifies the display to connect to.
46                        <code class="constant">EGL_DEFAULT_DISPLAY</code> indicates the default display.
47                    </p>
48            </dd>
49          </dl>
50        </div>
51      </div>
52      <div class="refsect1" id="description">
53        <h2>Description</h2>
54        <p>
55            <code class="function">eglGetDisplay</code> obtains the
56            <abbr class="acronym">EGL</abbr> display connection for the native
57            display <em class="parameter"><code>native_display</code></em>.
58        </p>
59        <p>
60            The behavior of <code class="function">eglGetDisplay</code> is similar to
61            that of
62            <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a>,
63            but is specified in terms of implementation-specific behavior
64            rather than platform-specific extensions. As for
65            <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a>,
66            EGL considers the returned <span class="type">EGLDisplay</span> as belonging
67            to the same platform as <em class="parameter"><code>display_id</code></em>.
68            However, the set of platforms to which
69            <em class="parameter"><code>display_id</code></em> is permitted to belong, as
70            well as the actual type of <em class="parameter"><code>display_id</code></em>,
71            are implementation-specific. If
72            <em class="parameter"><code>display_id</code></em> is
73            <code class="constant">EGL_DEFAULT_DISPLAY</code>, a <em class="firstterm">default
74            display</em> is returned. Multiple calls made to
75            <code class="function">eglGetDisplay</code> with the same
76            <em class="parameter"><code>display_id</code></em> will return the same
77            <span class="type">EGLDisplay</span> handle.
78        </p>
79        <p>
80            If <em class="parameter"><code>display_id</code></em> is
81            <code class="constant">EGL_DEFAULT_DISPLAY</code>, a default display connection is returned.
82        </p>
83        <p>
84            If no display connection matching <em class="parameter"><code>native_display</code></em> is
85            available, <code class="constant">EGL_NO_DISPLAY</code> is returned. No
86            error is generated.
87        </p>
88        <p>
89            Use <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>
90            to initialize the display connection.
91        </p>
92      </div>
93      <div class="refsect1" id="seealso">
94        <h2>See Also</h2>
95        <p>
96            <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>,
97            <a class="citerefentry" href="eglGetPlatformDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetPlatformDisplay</span></span></a>
98        </p>
99      </div>
100      <p>
101    </p>
102      <div class="refsect3" id="copyright">
103        <img src="KhronosLogo.jpg"/>
104        <p>
105            Copyright © 2003-2014 The Khronos Group Inc.
106            Permission is hereby granted, free of charge, to any person obtaining a
107            copy of this software and/or associated documentation files (the
108            "Materials"), to deal in the Materials without restriction, including
109            without limitation the rights to use, copy, modify, merge, publish,
110            distribute, sublicense, and/or sell copies of the Materials, and to
111            permit persons to whom the Materials are furnished to do so, subject to
112            the condition that this copyright notice and permission notice shall be included
113            in all copies or substantial portions of the Materials.
114        </p>
115      </div>
116      <p>
117</p>
118    </div>
119    <footer/>
120  </body>
121</html>
122