• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3<!-- saved from url=(0013)about:internet -->
4<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
5  <head>
6    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
7    <style xmlns="" type="text/css">
8    /* This style sets a margin around the entire page */
9        html, body {
10            margin: 10px;
11        }
12
13        p {
14            font: normal 16px verdana, sans-serif;
15            margin: 0;
16            padding-bottom:12px;
17        }
18
19        h1 {
20            font: bold 25px verdana, sans-serif;
21            margin-top: 0;
22            margin-bottom: 3px;
23            padding-top: 0;
24            padding-bottom: 0;
25        }
26
27        h2 {
28            font: bold 19px verdana, sans-serif;
29            margin-top: 28px;
30            margin-bottom: 3px;
31            padding-top: 0;
32            padding-bottom: 0;
33        }
34
35        h3 {
36            font: bold 19px verdana, sans-serif !important;
37            margin-top: 28px;
38            margin-bottom: 3px;
39            padding-top: 0;
40            padding-bottom: 0;
41        }
42
43        li {
44            font: normal 16px verdana, sans-serif;
45            margin-top: 0;
46            margin-bottom: 18px;
47            padding-top: 0;
48            padding-bottom: 0;
49        }
50
51        .pdparam {
52            font: italic 16px verdana, sans-serif;
53        }
54
55                .term {
56                        font: italic 16px verdana, sans-serif;
57                        font-weight: normal;
58                }
59
60                .type {
61                        font: normal 16px verdana, sans-serif !important;
62                }
63
64                .parameter {
65                        font-style: italic;
66                        }
67
68        a:link, a:visited {
69            color: blue;
70            text-decoration: none;
71            font: normal 16px;
72        }
73
74        a:hover {
75            background-color: #FFFF99;
76            font: normal 16px;
77        }
78
79        div.funcsynopsis {
80            text-align: left;
81            background-color: #e6e6e6;
82            font: normal 16px verdana, sans-serif;
83                        padding-top: 10px;
84                        padding-bottom: 10px;
85        }
86
87        div.funcsynopsis table {
88            border-collapse: separate;
89            font: normal 16px verdana, sans-serif;
90        }
91
92        div.funcsynopsis td {
93            background-color: #e6e6e6;
94            border: 0 solid #000;
95            padding: 1px;
96            font: normal 16px verdana, sans-serif;
97        }
98
99        div.refsect1 {
100            font-family: verdana, sans-serif;
101            font-size: 16px;
102        }
103
104        code.constant {
105            font: normal 16px courier new, monospace !important;
106        }
107
108                span.errorname {
109            font: normal 16px verdana, sans-serif !important;
110        }
111
112        code.function {
113            font: bold 16px verdana, sans-serif !important;
114        }
115
116        b.fsfunc {
117            font: bold 16px verdana, sans-serif !important;
118        }
119
120        code.varname {
121            font: italic 16px verdana, sans-serif;
122        }
123
124        code.replaceable {
125            font: italic 16px courier new, monospace;
126        }
127
128        code.funcdef {
129            font: normal 16px verdana, sans-serif !important;
130        }
131
132        .citerefentry {
133            font: normal 16px verdana, sans-serif !important;
134        }
135
136        .parameter {
137            font-style: italic;
138        }
139
140        code.fsfunc {
141            font: normal 16px verdana, sans-serif !important;
142        }
143
144        /* PARAMETER: This style controls spacing between the terms in Parameter section */
145        dt {
146            margin-top: 15px;
147        }
148
149        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
150        div.refsect1 table {
151            width: 100%;
152                        margin-top: 10px;
153            background-color: #FFF;
154                        border-collapse: collapse;
155                        border-color: #000;
156            border-width: 1px;
157                        font: normal 16px verdana, sans-serif;
158        }
159
160        div.refsect1 th {
161                        border-collapse: collapse;
162                        border-color: #000;
163            border-width: 1px;
164            font: bold 16px verdana, sans-serif;
165        }
166
167        div.refsect1 td {
168            background-color: #FFF;
169            padding: 5px;
170            vertical-align: text-top;
171                        border-collapse: collapse;
172                        border-color: #000;
173            border-width: 1px;
174            font: normal 16px verdana, sans-serif;
175        }
176
177                  div.refsect1 p{
178            font: normal 16px verdana, sans-serif;
179            margin-top: 8px;
180            margin-bottom: 8px;
181            padding-top: 0;
182            padding-bottom: 0;
183        }
184
185
186        /* EXAMPLE: These styles apply only to the Example section */
187        div.refsect2 {
188            font: normal 16px courier new, monospace !important;
189        }
190
191        div.refsect2 table {
192            margin-top: 0;
193            background-color: #e6e6e6;
194            width: 100%;
195            border: 0 solid #000;
196            padding: 2px;
197            font: normal 16px courier new, monospace !important;
198        }
199
200        div.refsect2 td {
201            background-color: #e6e6e6;
202            font: normal 16px courier new, monospace !important;
203                        white-space:pre;
204        }
205
206        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
207        div.refsect3 {
208            font: normal 11px verdana, sans-serif;
209            margin-top: 50px;
210            margin-bottom: 20px;
211            padding-top: 0;
212            padding-bottom: 0;
213        }
214
215</style>
216    <title>eglGetConfigs</title>
217    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
218  </head>
219  <body>
220    <div class="refentry">
221      <a id="eglGetConfigs"></a>
222      <div class="titlepage"></div>
223      <div xmlns="" class="refnamediv">
224        <h1>eglGetConfigs</h1>
225        <p>
226            return a list of all <acronym xmlns="http://www.w3.org/1999/xhtml" class="acronym">EGL</acronym> frame buffer configurations
227            for a display
228        </p>
229      </div>
230      <div class="refsynopsisdiv">
231        <h2>C Specification</h2>
232        <div class="funcsynopsis">
233          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
234            <tr valign="bottom">
235              <td>
236                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigs</strong>(</code>
237                <td>EGLDisplay  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">display</var>, </td>
238              </td>
239            </tr>
240            <tr valign="top">
241              <td> </td>
242              <td>EGLConfig *  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">configs</var>, </td>
243            </tr>
244            <tr valign="top">
245              <td> </td>
246              <td>EGLint  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">config_size</var>, </td>
247            </tr>
248            <tr valign="top">
249              <td> </td>
250              <td>EGLint *  <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_config</var><code>)</code></td>
251            </tr>
252          </table>
253        </div>
254      </div>
255      <div class="refsect1">
256        <a id="parameters"></a>
257        <h2>Parameters</h2>
258        <div class="variablelist">
259          <dl class="variablelist">
260            <dt>
261              <span class="term">
262                <em class="parameter">
263                  <code>display</code>
264                </em>
265              </span>
266            </dt>
267            <dd>
268              <p>Specifies the EGL display connection.</p>
269            </dd>
270            <dt>
271              <span class="term">
272                <em class="parameter">
273                  <code>configs</code>
274                </em>
275              </span>
276            </dt>
277            <dd>
278              <p>Returns a list of configs.</p>
279            </dd>
280            <dt>
281              <span class="term">
282                <em class="parameter">
283                  <code>config_size</code>
284                </em>
285              </span>
286            </dt>
287            <dd>
288              <p>Specifies the size of the list of configs.
289                </p>
290            </dd>
291            <dt>
292              <span class="term">
293                <em class="parameter">
294                  <code>num_config</code>
295                </em>
296              </span>
297            </dt>
298            <dd>
299              <p>Returns the number of configs returned.
300                </p>
301            </dd>
302          </dl>
303        </div>
304      </div>
305      <div class="refsect1">
306        <a id="description"></a>
307        <h2>Description</h2>
308        <p>
309            <code class="function">eglGetConfigs</code> returns a list of all
310            EGL frame buffer configurations that are available for the specified
311            display.
312            The items in the list can be used in any EGL function that requires
313            an EGL frame buffer configuration.
314        </p>
315        <p>
316            <em class="parameter"><code>configs</code></em> does not return values, if it is specified
317            as
318            <code class="constant">NULL</code>. This is useful for querying just the
319            number of all frame buffer configurations.
320        </p>
321        <p>
322            Use
323            <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>
324            to retrieve individual attribute values of a frame buffer configuration.
325        </p>
326      </div>
327      <div class="refsect1">
328        <a id="errors"></a>
329        <h2>Errors</h2>
330        <p>
331            <code class="constant">EGL_FALSE</code> is returned on failure,
332            <code class="constant">EGL_TRUE</code> otherwise.
333            <em class="parameter"><code>configs</code></em> and <em class="parameter"><code>num_config</code></em>
334            are not modified when
335            <code class="constant">EGL_FALSE</code> is returned.
336        </p>
337        <p>
338            <code class="constant">EGL_BAD_DISPLAY</code> is generated if
339            <em class="parameter"><code>display</code></em> is not an EGL display connection.
340        </p>
341        <p>
342            <code class="constant">EGL_NOT_INITIALIZED</code> is generated if
343            <em class="parameter"><code>display</code></em> has not been initialized.
344        </p>
345        <p>
346            <code class="constant">EGL_BAD_PARAMETER</code> is generated if
347            <em class="parameter"><code>num_config</code></em> is <code class="constant">NULL</code>.
348        </p>
349      </div>
350      <div class="refsect1">
351        <a id="seealso"></a>
352        <h2>See Also</h2>
353        <p>
354            <a class="citerefentry" href="eglCreateContext.html"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>,
355            <a class="citerefentry" href="eglCreatePbufferSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>,
356            <a class="citerefentry" href="eglCreatePixmapSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>,
357            <a class="citerefentry" href="eglCreateWindowSurface.html"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>,
358            <a class="citerefentry" href="eglChooseConfig.html"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>,
359            <a class="citerefentry" href="eglGetConfigAttrib.html"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>
360        </p>
361      </div>
362      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>
363Copyright © 2003-2014 The Khronos Group Inc.
364Permission is hereby granted, free of charge, to any person obtaining a
365copy of this software and/or associated documentation files (the
366"Materials"), to deal in the Materials without restriction, including
367without limitation the rights to use, copy, modify, merge, publish,
368distribute, sublicense, and/or sell copies of the Materials, and to
369permit persons to whom the Materials are furnished to do so, subject to
370the condition that this copyright notice and permission notice shall be included
371in all copies or substantial portions of the Materials.
372</div>
373    </div>
374  </body>
375</html>
376