upstream-man-pages/man2/glXQueryExtension.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="glXQueryExtension">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXQueryExtension</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXQueryExtension</refname>
  17         <refpurpose>indicate whether the GLX extension is supported</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>Bool <function>glXQueryExtension</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>int * <parameter>errorBase</parameter></paramdef>
  25                 <paramdef>int * <parameter>eventBase</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>errorBase</parameter></term>
  42             <listitem>
  43                 <para>
  44                     Returns the base error code of the GLX server extension.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         <varlistentry>
  49             <term><parameter>eventBase</parameter></term>
  50             <listitem>
  51                 <para>
  52                     Returns the base event code of the GLX server extension.
  53                 </para>
  54             </listitem>
  55         </varlistentry>
  56         </variablelist>
  57     </refsect1>
  58     <refsect1 id="description"><title>Description</title>
  59         <para>
  60             <function>glXQueryExtension</function> returns <constant>True</constant> if the X server of
  61             connection <parameter>dpy</parameter> supports the GLX extension,
  62             <constant>False</constant> otherwise.
  63             If <constant>True</constant> is returned,
  64             then <parameter>errorBase</parameter> and <parameter>eventBase</parameter> return the error base and event base of
  65             the GLX extension.  These values should be added to the constant
  66             error and event values to determine the actual event or error values.
  67             Otherwise, <parameter>errorBase</parameter> and <parameter>eventBase</parameter> are unchanged.
  68         </para>
  69         <para>
  70             <parameter>errorBase</parameter> and <parameter>eventBase</parameter> do not return values if they are specified
  71             as <constant>NULL</constant>.
  72         </para>
  73     </refsect1>
  74     <refsect1 id="seealso"><title>See Also</title>
  75         <para>
  76             <citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>
  77         </para>
  78     </refsect1>
  79     <refsect1 id="Copyright"><title>Copyright</title>
  80         <para>
  81             Copyright <trademark class="copyright"></trademark> 1991-2006
  82             Silicon Graphics, Inc. This document is licensed under the SGI
  83             Free Software B License. For details, see
  84             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  85         </para>
  86     </refsect1>
  87 </refentry>