upstream-doc/man2/glXQueryServerString.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="glXQueryServerString">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXQueryServerString</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXQueryServerString</refname>
  17         <refpurpose>return string describing the server</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>const char * <function>glXQueryServerString</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>int <parameter>screen</parameter></paramdef>
  25                 <paramdef>int <parameter>name</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>name</parameter></term>
  50             <listitem>
  51                 <para>
  52                     Specifies which string is returned:
  53                     one of <constant>GLX_VENDOR</constant>, <constant>GLX_VERSION</constant>, or <constant>GLX_EXTENSIONS</constant>.
  54                 </para>
  55             </listitem>
  56         </varlistentry>
  57         </variablelist>
  58     </refsect1>
  59     <refsect1 id="description"><title>Description</title>
  60         <para>
  61             <function>glXQueryServerString</function>
  62             returns a pointer to a static, null-terminated string
  63             describing some aspect of the server's GLX extension. The possible values for
  64             <parameter>name</parameter> and the format of the strings is the same as for
  65             <citerefentry><refentrytitle>glXGetClientString</refentrytitle></citerefentry>. If <parameter>name</parameter> is not set to a recognized value,
  66             <constant>NULL</constant> is returned.
  67         </para>
  68     </refsect1>
  69     <refsect1 id="notes"><title>Notes</title>
  70         <para>
  71             <function>glXQueryServerString</function> is available only if the GLX version is 1.1 or greater.
  72         </para>
  73         <para>
  74             If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
  75             If the GLX version is 1.2, the GL version must be 1.1.
  76             If the GLX version is 1.3, the GL version must be 1.2.
  77         </para>
  78         <para>
  79             <function>glXQueryServerString</function> only returns information about GLX extensions supported by the server.
  80             Call <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry> to get a list of GL extensions.
  81             Call <citerefentry><refentrytitle>glXGetClientString</refentrytitle></citerefentry> to get a list of GLX extensions supported by the
  82             client.
  83         </para>
  84     </refsect1>
  85     <refsect1 id="seealso"><title>See Also</title>
  86         <para>
  87             <citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>,
  88             <citerefentry><refentrytitle>glXGetClientString</refentrytitle></citerefentry>,
  89             <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>
  90         </para>
  91     </refsect1>
  92     <refsect1 id="Copyright"><title>Copyright</title>
  93         <para>
  94             Copyright <trademark class="copyright"></trademark> 1991-2006
  95             Silicon Graphics, Inc. This document is licensed under the SGI
  96             Free Software B License. For details, see
  97             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  98         </para>
  99     </refsect1>
 100 </refentry>