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">eglGetPlatformDisplay - 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="eglGetPlatformDisplay"> 11 <div class="titlepage"/> 12 <div class="refnamediv"> 13 <h2>Name</h2> 14 <p>eglGetPlatformDisplay — 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">eglGetPlatformDisplay</strong>(</code> 25 </td> 26 <td>EGLenum <var class="pdparam">platform</var>, </td> 27 </tr> 28 <tr> 29 <td> </td> 30 <td>void * <var class="pdparam">native_display</var>, </td> 31 </tr> 32 <tr> 33 <td> </td> 34 <td>const EGLAttrib * <var class="pdparam">attrib_list</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>platform</code> 48 </em> 49 </span> 50 </dt> 51 <dd> 52 <p> 53 Specifies the native platform to obtain a display for. 54 </p> 55 </dd> 56 <dt> 57 <span class="term"> 58 <em class="parameter"> 59 <code>native_display</code> 60 </em> 61 </span> 62 </dt> 63 <dd> 64 <p> 65 Specifies the native display to connect to. 66 </p> 67 </dd> 68 <dt> 69 <span class="term"> 70 <em class="parameter"> 71 <code>attrib_list</code> 72 </em> 73 </span> 74 </dt> 75 <dd> 76 <p> 77 Specifies attributes of the display being obtained. 78 </p> 79 </dd> 80 </dl> 81 </div> 82 </div> 83 <div class="refsect1" id="description"> 84 <h2>Description</h2> 85 <p> 86 <code class="function">eglGetPlatformDisplay</code> obtains an 87 <abbr class="acronym">EGL</abbr> display connection for the specified 88 <em class="parameter"><code>platform</code></em> and 89 <em class="parameter"><code>native_display</code></em>. 90 </p> 91 <p> 92 Valid values for <em class="parameter"><code>platform</code></em> are defined by 93 EGL extensions, as are requirements for 94 <em class="parameter"><code>native_display</code></em>. 95 For example, an extension specification that defines support for 96 the X11 platform may require that 97 <em class="parameter"><code>native_display</code></em> be a pointer to an X11 98 Display, and an extension specification that defines support for 99 the Microsoft Windows platform may require that 100 <em class="parameter"><code>native_display</code></em> be a pointer to a Windows 101 Device Context. 102 </p> 103 <p> 104 Valid attributes are defined by EGL extensions. 105 All attributes in <em class="parameter"><code>attrib_list</code></em>, 106 including boolean attributes, are immediately followed by 107 the corresponding desired value. 108 The list is terminated with <code class="constant">EGL_NONE</code>. 109 If an attribute is not specified in 110 <em class="parameter"><code>attrib_list</code></em> but is required for the 111 specified <em class="parameter"><code>platform</code></em>, then a default value 112 is used (and the attribute is said to be specified implicitly). 113 </p> 114 <p> 115 Multiple calls made to 116 <code class="function">eglGetPlatformDisplay</code> with the same 117 parameters will return the same <span class="type">EGLDisplay</span> handle. 118 </p> 119 <p> 120 If <em class="parameter"><code>platform</code></em> is valid but no display 121 matching <em class="parameter"><code>native_display</code></em> is available, 122 then <code class="constant">EGL_NO_DISPLAY</code> is returned; no error 123 condition is raised in this case. 124 </p> 125 </div> 126 <div class="refsect1" id="notes"> 127 <h2>Notes</h2> 128 <p> 129 <code class="function">eglGetPlatformDisplay</code> is supported only if 130 the EGL version is 1.5 or greater. 131 </p> 132 </div> 133 <div class="refsect1" id="errors"> 134 <h2>Errors</h2> 135 <p> 136 <code class="function">eglGetPlatformDisplay</code> returns 137 <code class="constant">EGL_NO_DISPLAY</code> on failure. 138 </p> 139 <p> 140 An <code class="constant">EGL_BAD_PARAMETER</code> error is generated if 141 <em class="parameter"><code>platform</code></em> has an invalid value. 142 </p> 143 </div> 144 <div class="refsect1" id="seealso"> 145 <h2>See Also</h2> 146 <p> 147 <a class="citerefentry" href="eglInitialize.xhtml"><span class="citerefentry"><span class="refentrytitle">eglInitialize</span></span></a>, 148 <a class="citerefentry" href="eglGetDisplay.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetDisplay</span></span></a> 149 </p> 150 </div> 151 <p> 152 </p> 153 <div class="refsect3" id="copyright"> 154 <img src="KhronosLogo.jpg"/> 155 <p> 156 Copyright © 2003-2014 The Khronos Group Inc. 157 Permission is hereby granted, free of charge, to any person obtaining a 158 copy of this software and/or associated documentation files (the 159 "Materials"), to deal in the Materials without restriction, including 160 without limitation the rights to use, copy, modify, merge, publish, 161 distribute, sublicense, and/or sell copies of the Materials, and to 162 permit persons to whom the Materials are furnished to do so, subject to 163 the condition that this copyright notice and permission notice shall be included 164 in all copies or substantial portions of the Materials. 165 </p> 166 </div> 167 <p> 168</p> 169 </div> 170 <footer/> 171 </body> 172</html> 173
