Return to eglGetConfigs.xml CVS log

Up to [Development] / projects / ogl-sample / main / doc / gles / xml

OpenGL ES 1.0 and EGL 1.0 reference manual and man pages (written by
Claude Knaus, based on OpenGL SI man pages).

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "DTD/docbook/docbookx.dtd">

<!--
  License Applicability. Except to the extent portions of this file are
  made subject to an alternative license as permitted in the SGI Free
  Software License B, Version 1.1 (the "License"), the contents of this
  file are subject only to the provisions of the License. You may not use
  this file except in compliance with the License. You may obtain a copy
  of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
  Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:

  http://oss.sgi.com/projects/FreeB

  Note that, as provided in the License, the Software is distributed on an
  "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
  DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
  CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
  PARTICULAR PURPOSE, AND NON-INFRINGEMENT.

  Original Code. The Original Code is: OpenGL ES Reference Manual,
  Version 1.0, released September 2003, developed by Silicon Graphics,
  Inc.  The Original Code is Copyright (c) 2003 Silicon Graphics, Inc.
  Copyright in any portions created by third parties is as indicated
  elsewhere herein.  All Rights Reserved.
-->

<refentry id="eglGetConfigs">

  <refmeta>
    <refentrytitle>eglGetConfigs</refentrytitle>
    <manvolnum>3G</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>eglGetConfigs</refname>
    <refpurpose>
      return a list of all <acronym>EGL</acronym> frame buffer configurations
      for a display
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>C Specification</title>

    <funcsynopsis>
      <funcprototype>
        <funcdef>EGLBoolean <function>eglGetConfigs</function></funcdef>
        <paramdef>EGLDisplay <parameter>display</parameter></paramdef>
        <paramdef>EGLConfig * <parameter>configs</parameter></paramdef>
        <paramdef>EGLint <parameter>config_size</parameter></paramdef>
        <paramdef>EGLint * <parameter>num_config</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term><parameter>display</parameter></term>
        <listitem><para>Specifies the EGL display connection.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>configs</parameter></term>
        <listitem><para>Returns a list of configs.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>config_size</parameter></term>
        <listitem><para>Specifies the size of the list of configs.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>num_config</parameter></term>
        <listitem><para>Returns the number of configs returned.
        </para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>
      <function>eglGetConfigs</function> 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.
    </para>

    <para>
      <parameter>configs</parameter> does not return values, if it is specified
      as
      <constant>NULL</constant>. This is useful for querying just the
      number of all frame buffer configurations.
    </para>

    <para>
      Use 
      <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry>
      to retrieve individual attribute values of a frame buffer configuration.
    </para>
  </refsect1>

  <refsect1>
    <title>Errors</title>

    <para>
      <constant>EGL_FALSE</constant> is returned on failure,
      <constant>EGL_TRUE</constant> otherwise.
      <parameter>configs</parameter> and <parameter>num_config</parameter>
      are not modified when
      <constant>EGL_FALSE</constant> is returned.
    </para>

    <para>
      <constant>EGL_BAD_DISPLAY</constant> is generated if
      <parameter>display</parameter> is not an EGL display connection.
    </para>
    
    <para>
      <constant>EGL_NOT_INITIALIZED</constant> is generated if
      <parameter>display</parameter> has not been initialized.
    </para>

    <para>
      <constant>EGL_BAD_PARAMETER</constant> is generated if
      <parameter>num_config</parameter> is <constant>NULL</constant>.
    </para>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <para>
      <citerefentry><refentrytitle>eglCreateContext</refentrytitle></citerefentry>,
      <citerefentry><refentrytitle>eglCreatePbufferSurface</refentrytitle></citerefentry>,
      <citerefentry><refentrytitle>eglCreatePixmapSurface</refentrytitle></citerefentry>,
      <citerefentry><refentrytitle>eglCreateWindowSurface</refentrytitle></citerefentry>,
      <citerefentry><refentrytitle>eglChooseConfig</refentrytitle></citerefentry>,
      <citerefentry><refentrytitle>eglGetConfigAttrib</refentrytitle></citerefentry>
    </para>
  </refsect1>

</refentry>