upstream-man-pages/man2/glXGetClientString.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="glXGetClientString">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXGetClientString</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXGetClientString</refname>
  17         <refpurpose>return a string describing the client</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>const char * <function>glXGetClientString</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>int <parameter>name</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <!-- eqn: ignoring delim $$ -->
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>dpy</parameter></term>
  33             <listitem>
  34                 <para>
  35                     Specifies the connection to the X server.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>name</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies which string is returned.
  44                     The symbolic constants <constant>GLX_VENDOR</constant>, <constant>GLX_VERSION</constant>,
  45                     and <constant>GLX_EXTENSIONS</constant> are accepted.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         </variablelist>
  50     </refsect1>
  51     <refsect1 id="description"><title>Description</title>
  52         <para>
  53             <function>glXGetClientString</function> returns a string
  54             describing some aspect of the client library. The possible values for <parameter>name</parameter>
  55             are <constant>GLX_VENDOR</constant>, <constant>GLX_VERSION</constant>, and
  56             <constant>GLX_EXTENSIONS</constant>. If <parameter>name</parameter>
  57             is not set to one of these values, <function>glXGetClientString</function> returns <constant>NULL</constant>.
  58             The format and contents of the vendor string is implementation dependent.
  59         </para>
  60         <para>
  61             The extensions string is null-terminated and contains a
  62             space-separated list of  extension names. (The extension names never
  63             contain spaces.)
  64             If there are no extensions to GLX, then the empty string is returned.
  65         </para>
  66         <para>
  67             The version string is laid out as follows:
  68         </para>
  69         <para>
  70             &lt;major_version.minor_version&gt;&lt;space&gt;&lt;vendor-specific info&gt;
  71         </para>
  72         <para>
  73             Both the major and minor portions of the version number are of arbitrary
  74             length.  The vendor-specific information is optional.  However, if it is
  75             present, the format and contents are implementation specific.
  76         </para>
  77     </refsect1>
  78     <refsect1 id="notes"><title>Notes</title>
  79         <para>
  80             <function>glXGetClientString</function> is available only if the GLX version is 1.1 or greater.
  81         </para>
  82         <para>
  83             If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
  84             If the GLX version is 1.2, then the GL version must be 1.1.
  85             If the GLX version is 1.3, then the GL version must be 1.2.
  86         </para>
  87         <para>
  88             <function>glXGetClientString</function> only returns information about GLX extensions supported by the client.
  89             Call <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry> to get a list of GL extensions supported by the server.
  90         </para>
  91     </refsect1>
  92     <refsect1 id="seealso"><title>See Also</title>
  93         <para>
  94             <citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>,
  95             <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>,
  96             <citerefentry><refentrytitle>glXQueryServerString</refentrytitle></citerefentry>
  97         </para>
  98     </refsect1>
  99     <refsect1 id="Copyright"><title>Copyright</title>
 100         <para>
 101             Copyright <trademark class="copyright"></trademark> 1991-2006
 102             Silicon Graphics, Inc. This document is licensed under the SGI
 103             Free Software B License. For details, see
 104             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 105         </para>
 106     </refsect1>
 107 </refentry>