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">eglGetConfigs - 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="eglGetConfigs"> 11 <div class="titlepage"/> 12 <div class="refnamediv"> 13 <h2>Name</h2> 14 <p>eglGetConfigs — 15 return a list of all <abbr class="acronym">EGL</abbr> frame buffer configurations 16 for a display 17 </p> 18 </div> 19 <div class="refsynopsisdiv"> 20 <h2>C Specification</h2> 21 <div class="funcsynopsis"> 22 <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table"> 23 <tr> 24 <td> 25 <code class="funcdef">EGLBoolean <strong class="fsfunc">eglGetConfigs</strong>(</code> 26 </td> 27 <td>EGLDisplay <var class="pdparam">display</var>, </td> 28 </tr> 29 <tr> 30 <td> </td> 31 <td>EGLConfig * <var class="pdparam">configs</var>, </td> 32 </tr> 33 <tr> 34 <td> </td> 35 <td>EGLint <var class="pdparam">config_size</var>, </td> 36 </tr> 37 <tr> 38 <td> </td> 39 <td>EGLint * <var class="pdparam">num_config</var><code>)</code>;</td> 40 </tr> 41 </table> 42 <div class="funcprototype-spacer"> </div> 43 </div> 44 </div> 45 <div class="refsect1" id="parameters"> 46 <h2>Parameters</h2> 47 <div class="variablelist"> 48 <dl class="variablelist"> 49 <dt> 50 <span class="term"> 51 <em class="parameter"> 52 <code>display</code> 53 </em> 54 </span> 55 </dt> 56 <dd> 57 <p>Specifies the EGL display connection.</p> 58 </dd> 59 <dt> 60 <span class="term"> 61 <em class="parameter"> 62 <code>configs</code> 63 </em> 64 </span> 65 </dt> 66 <dd> 67 <p>Returns a list of configs.</p> 68 </dd> 69 <dt> 70 <span class="term"> 71 <em class="parameter"> 72 <code>config_size</code> 73 </em> 74 </span> 75 </dt> 76 <dd> 77 <p>Specifies the size of the list of configs. 78 </p> 79 </dd> 80 <dt> 81 <span class="term"> 82 <em class="parameter"> 83 <code>num_config</code> 84 </em> 85 </span> 86 </dt> 87 <dd> 88 <p>Returns the number of configs returned. 89 </p> 90 </dd> 91 </dl> 92 </div> 93 </div> 94 <div class="refsect1" id="description"> 95 <h2>Description</h2> 96 <p> 97 <code class="function">eglGetConfigs</code> returns a list of all 98 EGL frame buffer configurations that are available for the specified 99 display. 100 The items in the list can be used in any EGL function that requires 101 an EGL frame buffer configuration. 102 </p> 103 <p> 104 <em class="parameter"><code>configs</code></em> does not return values, if it is specified 105 as 106 <code class="constant">NULL</code>. This is useful for querying just the 107 number of all frame buffer configurations. 108 </p> 109 <p> 110 Use 111 <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> 112 to retrieve individual attribute values of a frame buffer configuration. 113 </p> 114 </div> 115 <div class="refsect1" id="errors"> 116 <h2>Errors</h2> 117 <p> 118 <code class="constant">EGL_FALSE</code> is returned on failure, 119 <code class="constant">EGL_TRUE</code> otherwise. 120 <em class="parameter"><code>configs</code></em> and <em class="parameter"><code>num_config</code></em> 121 are not modified when 122 <code class="constant">EGL_FALSE</code> is returned. 123 </p> 124 <p> 125 <code class="constant">EGL_BAD_DISPLAY</code> is generated if 126 <em class="parameter"><code>display</code></em> is not an EGL display connection. 127 </p> 128 <p> 129 <code class="constant">EGL_NOT_INITIALIZED</code> is generated if 130 <em class="parameter"><code>display</code></em> has not been initialized. 131 </p> 132 <p> 133 <code class="constant">EGL_BAD_PARAMETER</code> is generated if 134 <em class="parameter"><code>num_config</code></em> is <code class="constant">NULL</code>. 135 </p> 136 </div> 137 <div class="refsect1" id="seealso"> 138 <h2>See Also</h2> 139 <p> 140 <a class="citerefentry" href="eglCreateContext.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>, 141 <a class="citerefentry" href="eglCreatePbufferSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>, 142 <a class="citerefentry" href="eglCreatePixmapSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>, 143 <a class="citerefentry" href="eglCreateWindowSurface.xhtml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>, 144 <a class="citerefentry" href="eglChooseConfig.xhtml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>, 145 <a class="citerefentry" href="eglGetConfigAttrib.xhtml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a> 146 </p> 147 </div> 148 <p> 149 </p> 150 <div class="refsect3" id="copyright"> 151 <img src="KhronosLogo.jpg"/> 152 <p> 153 Copyright © 2003-2014 The Khronos Group Inc. 154 Permission is hereby granted, free of charge, to any person obtaining a 155 copy of this software and/or associated documentation files (the 156 "Materials"), to deal in the Materials without restriction, including 157 without limitation the rights to use, copy, modify, merge, publish, 158 distribute, sublicense, and/or sell copies of the Materials, and to 159 permit persons to whom the Materials are furnished to do so, subject to 160 the condition that this copyright notice and permission notice shall be included 161 in all copies or substantial portions of the Materials. 162 </p> 163 </div> 164 <p> 165</p> 166 </div> 167 <footer/> 168 </body> 169</html> 170
