upstream-man-pages/man2/glXGetVisualFromFBConfig.xml

   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="glXGetVisualFromFBConfig">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXGetVisualFromFBConfig</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXGetVisualFromFBConfig</refname>
  17         <refpurpose>return visual that is associated with the frame buffer configuration</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>XVisualInfo * <function>glXGetVisualFromFBConfig</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>GLXFBConfig <parameter>config</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>dpy</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the connection to the X server.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>config</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies the GLX frame buffer configuration.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             If <parameter>config</parameter> is a valid GLX frame buffer configuration
  51             and it has an associated X Visual, then
  52             information describing that visual is returned; otherwise <constant>NULL</constant>
  53             is returned. Use <function>XFree</function> to free the data returned.
  54         </para>
  55     </refsect1>
  56     <refsect1 id="notes"><title>Notes</title>
  57         <para>
  58             <function>glXGetVisualFromFBConfig</function> is available only if the GLX version is 1.3 or greater.
  59         </para>
  60         <para>
  61             If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
  62             If the GLX version is 1.2, then the GL version must be 1.1.
  63             If the GLX version is 1.3, then the GL version must be 1.2.
  64         </para>
  65         <para>
  66             <constant>XVisualInfo</constant> is defined in <emphasis>Xutil.h.</emphasis>
  67             It is a structure that includes <emphasis>visual</emphasis>, <emphasis>visualID</emphasis>,
  68             <emphasis>screen</emphasis>, and <emphasis>depth</emphasis> elements.
  69         </para>
  70     </refsect1>
  71     <refsect1 id="errors"><title>Errors</title>
  72         <para>
  73             Returns <constant>NULL</constant> if <parameter>config</parameter> is not a valid GLXFBConfig.
  74         </para>
  75     </refsect1>
  76     <refsect1 id="seealso"><title>See Also</title>
  77         <para>
  78             <citerefentry><refentrytitle>glXGetFBConfigAttrib</refentrytitle></citerefentry>,
  79             <citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry>,
  80             <citerefentry><refentrytitle>glXChooseVisual</refentrytitle></citerefentry>,
  81             <citerefentry><refentrytitle>glXGetConfig</refentrytitle></citerefentry>
  82         </para>
  83     </refsect1>
  84     <refsect1 id="Copyright"><title>Copyright</title>
  85         <para>
  86             Copyright <trademark class="copyright"></trademark> 1991-2006
  87             Silicon Graphics, Inc. This document is licensed under the SGI
  88             Free Software B License. For details, see
  89             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  90         </para>
  91     </refsect1>
  92 </refentry>