Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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 id="glXGetFBConfigs"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glXGetFBConfigs</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glXGetFBConfigs</refname> | |
17 | <refpurpose>list all GLX frame buffer configurations for a given screen</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>GLXFBConfig * <function>glXGetFBConfigs</function></funcdef> | |
23 | <paramdef>Display * <parameter>dpy</parameter></paramdef> | |
24 | <paramdef>int <parameter>screen</parameter></paramdef> | |
25 | <paramdef>int * <parameter>nelements</parameter></paramdef> | |
26 | </funcprototype> | |
27 | </funcsynopsis> | |
28 | </refsynopsisdiv> | |
29 | <!-- eqn: ignoring delim $$ --> | |
30 | <refsect1 id="parameters"><title>Parameters</title> | |
31 | <variablelist> | |
32 | <varlistentry> | |
33 | <term><parameter>dpy</parameter></term> | |
34 | <listitem> | |
35 | <para> | |
36 | Specifies the connection to the X server. | |
37 | </para> | |
38 | </listitem> | |
39 | </varlistentry> | |
40 | <varlistentry> | |
41 | <term><parameter>screen</parameter></term> | |
42 | <listitem> | |
43 | <para> | |
44 | Specifies the screen number. | |
45 | </para> | |
46 | </listitem> | |
47 | </varlistentry> | |
48 | <varlistentry> | |
49 | <term><parameter>nelements</parameter></term> | |
50 | <listitem> | |
51 | <para> | |
52 | Returns the number of GLXFBConfigs returned. | |
53 | </para> | |
54 | </listitem> | |
55 | </varlistentry> | |
56 | </variablelist> | |
57 | </refsect1> | |
58 | <refsect1 id="description"><title>Description</title> | |
59 | <para> | |
60 | <function>glXGetFBConfigs</function> returns a list of all GLXFBConfigs available on the screen | |
61 | specified by <parameter>screen</parameter>. Use <citerefentry><refentrytitle>glXGetFBConfigAttrib</refentrytitle></citerefentry> to obtain attribute | |
62 | values from a specific GLXFBConfig. | |
63 | </para> | |
64 | </refsect1> | |
65 | <refsect1 id="notes"><title>Notes</title> | |
66 | <para> | |
67 | <function>glXGetFBConfigs</function> is available only if the GLX version is 1.3 or greater. | |
68 | </para> | |
69 | <para> | |
70 | If the GLX version is 1.1 or 1.0, the GL version must be 1.0. | |
71 | If the GLX version is 1.2, then the GL version must be 1.1. | |
72 | If the GLX version is 1.3, then the GL version must be 1.2. | |
73 | </para> | |
74 | </refsect1> | |
75 | <refsect1 id="seealso"><title>See Also</title> | |
76 | <para> | |
77 | <citerefentry><refentrytitle>glXGetFBConfigAttrib</refentrytitle></citerefentry>, | |
78 | <citerefentry><refentrytitle>glXGetVisualFromFBConfig</refentrytitle></citerefentry> | |
79 | <citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry> | |
80 | </para> | |
81 | </refsect1> | |
82 | <refsect1 id="Copyright"><title>Copyright</title> | |
83 | <para> | |
84 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
85 | Silicon Graphics, Inc. This document is licensed under the SGI | |
86 | Free Software B License. For details, see | |
87 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
88 | </para> | |
89 | </refsect1> | |
90 | </refentry> |