1<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglGetPlatformDisplay"> 2 <info> 3 <copyright> 4 <year>2018</year> 5 <holder>The Khronos Group Inc.</holder> 6 </copyright> 7 </info> 8 <refmeta> 9 <refentrytitle>eglGetPlatformDisplay</refentrytitle> 10 <manvolnum>3G</manvolnum> 11 </refmeta> 12 <refnamediv> 13 <refname>eglGetPlatformDisplay</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>eglGetPlatformDisplay</function></funcdef> 23 <paramdef>EGLenum <parameter>platform</parameter></paramdef> 24 <paramdef>void * <parameter>native_display</parameter></paramdef> 25 <paramdef>const EGLAttrib * <parameter>attrib_list</parameter></paramdef> 26 </funcprototype> 27 </funcsynopsis> 28 </refsynopsisdiv> 29 <refsect1 xml:id="parameters"><title>Parameters</title> 30 <variablelist> 31 <varlistentry> 32 <term><parameter>platform</parameter></term> 33 <listitem> 34 <para> 35 Specifies the native platform to obtain a display for. 36 </para> 37 </listitem> 38 </varlistentry> 39 <varlistentry> 40 <term><parameter>native_display</parameter></term> 41 <listitem> 42 <para> 43 Specifies the native display to connect to. 44 </para> 45 </listitem> 46 </varlistentry> 47 <varlistentry> 48 <term><parameter>attrib_list</parameter></term> 49 <listitem> 50 <para> 51 Specifies attributes of the display being obtained. 52 </para> 53 </listitem> 54 </varlistentry> 55 </variablelist> 56 </refsect1> 57 <refsect1 xml:id="description"><title>Description</title> 58 <para> 59 <function>eglGetPlatformDisplay</function> obtains an 60 <acronym>EGL</acronym> display connection for the specified 61 <parameter>platform</parameter> and 62 <parameter>native_display</parameter>. 63 </para> 64 <para> 65 Valid values for <parameter>platform</parameter> are defined by 66 EGL extensions, as are requirements for 67 <parameter>native_display</parameter>. 68 For example, an extension specification that defines support for 69 the X11 platform may require that 70 <parameter>native_display</parameter> be a pointer to an X11 71 Display, and an extension specification that defines support for 72 the Microsoft Windows platform may require that 73 <parameter>native_display</parameter> be a pointer to a Windows 74 Device Context. 75 </para> 76 <para> 77 Valid attributes are defined by EGL extensions. 78 All attributes in <parameter>attrib_list</parameter>, 79 including boolean attributes, are immediately followed by 80 the corresponding desired value. 81 The list is terminated with <constant>EGL_NONE</constant>. 82 If an attribute is not specified in 83 <parameter>attrib_list</parameter> but is required for the 84 specified <parameter>platform</parameter>, then a default value 85 is used (and the attribute is said to be specified implicitly). 86 </para> 87 <para> 88 Multiple calls made to 89 <function>eglGetPlatformDisplay</function> with the same 90 parameters will return the same <type>EGLDisplay</type> handle. 91 </para> 92 <para> 93 If <parameter>platform</parameter> is valid but no display 94 matching <parameter>native_display</parameter> is available, 95 then <constant>EGL_NO_DISPLAY</constant> is returned; no error 96 condition is raised in this case. 97 </para> 98 </refsect1> 99 <refsect1 xml:id="notes"><title>Notes</title> 100 <para> 101 <function>eglGetPlatformDisplay</function> is supported only if 102 the EGL version is 1.5 or greater. 103 </para> 104 </refsect1> 105 <refsect1 xml:id="errors"><title>Errors</title> 106 <para> 107 <function>eglGetPlatformDisplay</function> returns 108 <constant>EGL_NO_DISPLAY</constant> on failure. 109 </para> 110 <para> 111 An <constant>EGL_BAD_PARAMETER</constant> error is generated if 112 <parameter>platform</parameter> has an invalid value. 113 </para> 114 </refsect1> 115 <refsect1 xml:id="seealso"><title>See Also</title> 116 <para> 117 <citerefentry><refentrytitle>eglInitialize</refentrytitle></citerefentry>, 118 <citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry> 119 </para> 120 </refsect1> 121 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> 122</refentry> 123