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