<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?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" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>eglGetConfigs</title><meta name="generator" content="DocBook XSL Stylesheets V1.74.0" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="eglGetConfigs"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>eglGetConfigs — 
            return a list of all <acronym class="acronym">EGL</acronym> frame buffer configurations
            for a display
        </p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">EGLBoolean <b class="fsfunc">eglGetConfigs</b>(</code></td><td>EGLDisplay <var class="pdparam">display</var>, </td></tr><tr><td> </td><td>EGLConfig * <var class="pdparam">configs</var>, </td></tr><tr><td> </td><td>EGLint <var class="pdparam">config_size</var>, </td></tr><tr><td> </td><td>EGLint * <var class="pdparam">num_config</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>display</code></em></span></dt><dd><p>Specifies the EGL display connection.</p></dd><dt><span class="term"><em class="parameter"><code>configs</code></em></span></dt><dd><p>Returns a list of configs.</p></dd><dt><span class="term"><em class="parameter"><code>config_size</code></em></span></dt><dd><p>Specifies the size of the list of configs.
                </p></dd><dt><span class="term"><em class="parameter"><code>num_config</code></em></span></dt><dd><p>Returns the number of configs returned.
                </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
            <code class="function">eglGetConfigs</code> returns a list of all
            EGL frame buffer configurations that are available for the specified
            display.
            The items in the list can be used in any EGL function that requires
            an EGL frame buffer configuration.
        </p><p>
            <em class="parameter"><code>configs</code></em> does not return values, if it is specified
            as
            <code class="constant">NULL</code>. This is useful for querying just the
            number of all frame buffer configurations.
        </p><p>
            Use
            <a class="citerefentry" href="eglGetConfigAttrib.xml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>
            to retrieve individual attribute values of a frame buffer configuration.
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
            <code class="constant">EGL_FALSE</code> is returned on failure,
            <code class="constant">EGL_TRUE</code> otherwise.
            <em class="parameter"><code>configs</code></em> and <em class="parameter"><code>num_config</code></em>
            are not modified when
            <code class="constant">EGL_FALSE</code> is returned.
        </p><p>
            <code class="constant">EGL_BAD_DISPLAY</code> is generated if
            <em class="parameter"><code>display</code></em> is not an EGL display connection.
        </p><p>
            <code class="constant">EGL_NOT_INITIALIZED</code> is generated if
            <em class="parameter"><code>display</code></em> has not been initialized.
        </p><p>
            <code class="constant">EGL_BAD_PARAMETER</code> is generated if
            <em class="parameter"><code>num_config</code></em> is <code class="constant">NULL</code>.
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
            <a class="citerefentry" href="eglCreateContext.xml"><span class="citerefentry"><span class="refentrytitle">eglCreateContext</span></span></a>,
            <a class="citerefentry" href="eglCreatePbufferSurface.xml"><span class="citerefentry"><span class="refentrytitle">eglCreatePbufferSurface</span></span></a>,
            <a class="citerefentry" href="eglCreatePixmapSurface.xml"><span class="citerefentry"><span class="refentrytitle">eglCreatePixmapSurface</span></span></a>,
            <a class="citerefentry" href="eglCreateWindowSurface.xml"><span class="citerefentry"><span class="refentrytitle">eglCreateWindowSurface</span></span></a>,
            <a class="citerefentry" href="eglChooseConfig.xml"><span class="citerefentry"><span class="refentrytitle">eglChooseConfig</span></span></a>,
            <a class="citerefentry" href="eglGetConfigAttrib.xml"><span class="citerefentry"><span class="refentrytitle">eglGetConfigAttrib</span></span></a>
        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="copyright"></a><h2>Copyright</h2><p>
            Copyright <span class="trademark"></span>© 2003-2004
            Silicon Graphics, Inc. This document is licensed under the SGI
            Free Software B License. For details, see
            <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
        </p></div></div></body></html>

