1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
3                            "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
4<refentry xml:base="" id="eglGetConfigs">
5    <refentryinfo>
6         <copyright>
7             <year>2003-2014</year>
8             <holder>The Khronos Group Inc.</holder>
9         </copyright>
10    </refentryinfo>
11    <refmeta>
12        <refentrytitle>eglGetConfigs</refentrytitle>
13        <manvolnum>3G</manvolnum>
14    </refmeta>
15    <refnamediv>
16        <refname>eglGetConfigs</refname>
17        <refpurpose>
18            return a list of all <acronym>EGL</acronym> frame buffer configurations
19            for a display
20        </refpurpose>
21    </refnamediv>
22    <refsynopsisdiv>
23        <title>C Specification</title>
24        <funcsynopsis>
25            <funcprototype>
26                <funcdef>EGLBoolean <function>eglGetConfigs</function></funcdef>
27                <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
28                <paramdef>EGLConfig * <parameter>configs</parameter></paramdef>
29                <paramdef>EGLint <parameter>config_size</parameter></paramdef>
30                <paramdef>EGLint * <parameter>num_config</parameter></paramdef>
31            </funcprototype>
32        </funcsynopsis>
33    </refsynopsisdiv>
34    <refsect1 id="parameters"><title>Parameters</title>
35        <variablelist>
36            <varlistentry>
37                <term><parameter>display</parameter></term>
38                <listitem><para>Specifies the EGL display connection.</para></listitem>
39            </varlistentry>
40            <varlistentry>
41                <term><parameter>configs</parameter></term>
42                <listitem><para>Returns a list of configs.</para></listitem>
43            </varlistentry>
44            <varlistentry>
45                <term><parameter>config_size</parameter></term>
46                <listitem><para>Specifies the size of the list of configs.
47                </para></listitem>
48            </varlistentry>
49            <varlistentry>
50                <term><parameter>num_config</parameter></term>
51                <listitem><para>Returns the number of configs returned.
52                </para></listitem>
53            </varlistentry>
54        </variablelist>
55    </refsect1>
56    <refsect1 id="description"><title>Description</title>
57        <para>
58            <function>eglGetConfigs</function> returns a list of all
59            EGL frame buffer configurations that are available for the specified
60            display.
61            The items in the list can be used in any EGL function that requires
62            an EGL frame buffer configuration.
63        </para>
64        <para>
65            <parameter>configs</parameter> does not return values, if it is specified
66            as
67            <constant>NULL</constant>. This is useful for querying just the
68            number of all frame buffer configurations.
69        </para>
70        <para>
71            Use
72            <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry>
73            to retrieve individual attribute values of a frame buffer configuration.
74        </para>
75    </refsect1>
76    <refsect1 id="errors"><title>Errors</title>
77        <para>
78            <constant>EGL_FALSE</constant> is returned on failure,
79            <constant>EGL_TRUE</constant> otherwise.
80            <parameter>configs</parameter> and <parameter>num_config</parameter>
81            are not modified when
82            <constant>EGL_FALSE</constant> is returned.
83        </para>
84        <para>
85            <constant>EGL_BAD_DISPLAY</constant> is generated if
86            <parameter>display</parameter> is not an EGL display connection.
87        </para>
88        <para>
89            <constant>EGL_NOT_INITIALIZED</constant> is generated if
90            <parameter>display</parameter> has not been initialized.
91        </para>
92        <para>
93            <constant>EGL_BAD_PARAMETER</constant> is generated if
94            <parameter>num_config</parameter> is <constant>NULL</constant>.
95        </para>
96    </refsect1>
97    <refsect1 id="seealso"><title>See Also</title>
98        <para>
99            <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>,
100            <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>,
101            <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>,
102            <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>,
103            <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>,
104            <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry>
105        </para>
106    </refsect1>
107    <refsect3 id="Copyright"><title></title>
108        <!-- Content included from copyright.inc.xsl -->
109        <imageobject>
110                <imagedata fileref="KhronosLogo.jpg" format="jpg" />
111        </imageobject>
112        <para />
113    </refsect3>
114</refentry>
115