1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetDisplay"> 2 <info> 3 <copyright> 4 <year>2003-2018</year> 5 <holder>The Khronos Group Inc.</holder> 6 </copyright> 7 </info> 8 <refmeta> 9 <refentrytitle>eglGetDisplay</refentrytitle> 10 <manvolnum>3G</manvolnum> 11 </refmeta> 12 <refnamediv> 13 <refname>eglGetDisplay</refname> 14 <refpurpose> 15 return an <acronym>EGL</acronym> display connection 16 </refpurpose> 17 </refnamediv> 18 <refsynopsisdiv> 19 <title>C Specification</title> 20 <funcsynopsis> 21 <funcprototype> 22 <funcdef>EGLDisplay <function>eglGetDisplay</function></funcdef> 23 <paramdef>NativeDisplayType <parameter>native_display</parameter></paramdef> 24 </funcprototype> 25 </funcsynopsis> 26 </refsynopsisdiv> 27 <refsect1 xml:id="parameters"><title>Parameters</title> 28 <variablelist> 29 <varlistentry> 30 <term><parameter>native_display</parameter></term> 31 <listitem> 32 <para> 33 Specifies the display to connect to. 34 <constant>EGL_DEFAULT_DISPLAY</constant> indicates the default display. 35 </para> 36 </listitem> 37 </varlistentry> 38 </variablelist> 39 </refsect1> 40 <refsect1 xml:id="description"><title>Description</title> 41 <para> 42 <function>eglGetDisplay</function> obtains the 43 <acronym>EGL</acronym> display connection for the native 44 display <parameter>native_display</parameter>. 45 </para> 46 <para> 47 The behavior of <function>eglGetDisplay</function> is similar to 48 that of 49 <citerefentry><refentrytitle>eglGetPlatformDisplay</refentrytitle></citerefentry>, 50 but is specified in terms of implementation-specific behavior 51 rather than platform-specific extensions. As for 52 <citerefentry><refentrytitle>eglGetPlatformDisplay</refentrytitle></citerefentry>, 53 EGL considers the returned <type>EGLDisplay</type> as belonging 54 to the same platform as <parameter>display_id</parameter>. 55 However, the set of platforms to which 56 <parameter>display_id</parameter> is permitted to belong, as 57 well as the actual type of <parameter>display_id</parameter>, 58 are implementation-specific. If 59 <parameter>display_id</parameter> is 60 <constant>EGL_DEFAULT_DISPLAY</constant>, a <firstterm>default 61 display</firstterm> is returned. Multiple calls made to 62 <function>eglGetDisplay</function> with the same 63 <parameter>display_id</parameter> will return the same 64 <type>EGLDisplay</type> handle. 65 </para> 66 <para> 67 If <parameter>display_id</parameter> is 68 <constant>EGL_DEFAULT_DISPLAY</constant>, a default display connection is returned. 69 </para> 70 <para> 71 If no display connection matching <parameter>native_display</parameter> is 72 available, <constant>EGL_NO_DISPLAY</constant> is returned. No 73 error is generated. 74 </para> 75 <para> 76 Use <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry> 77 to initialize the display connection. 78 </para> 79 </refsect1> 80 <refsect1 xml:id="seealso"><title>See Also</title> 81 <para> 82 <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, 83 <citerefentry><refentrytitle>eglGetPlatformDisplay</refentrytitle></citerefentry> 84 </para> 85 </refsect1> 86 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> 87</refentry> 88