upstream-man-pages/man2/glXQueryContext.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="glXQueryContext">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXQueryContext</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXQueryContext</refname>
  17         <refpurpose>query context information</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>int <function>glXQueryContext</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>GLXContext <parameter>ctx</parameter></paramdef>
  25                 <paramdef>int <parameter>attribute</parameter></paramdef>
  26                 <paramdef>int * <parameter>value</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <!-- eqn: ignoring delim $$ -->
  31     <refsect1 id="parameters"><title>Parameters</title>
  32         <variablelist>
  33         <varlistentry>
  34             <term><parameter>dpy</parameter></term>
  35             <listitem>
  36                 <para>
  37                     Specifies the connection to the X server.
  38                 </para>
  39             </listitem>
  40         </varlistentry>
  41         <varlistentry>
  42             <term><parameter>ctx</parameter></term>
  43             <listitem>
  44                 <para>
  45                     Specifies a GLX rendering context.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         <varlistentry>
  50             <term><parameter>attribute</parameter></term>
  51             <listitem>
  52                 <para>
  53                     Specifies that a context parameter should be retrieved.  Must be one of
  54                     <constant>GLX_FBCONFIG_ID</constant>, <constant>GLX_RENDER_TYPE</constant>, or <constant>GLX_SCREEN</constant>.
  55                 </para>
  56             </listitem>
  57         </varlistentry>
  58         <varlistentry>
  59             <term><parameter>value</parameter></term>
  60             <listitem>
  61                 <para>
  62                     Contains the return value for <parameter>attribute</parameter>.
  63                 </para>
  64             </listitem>
  65         </varlistentry>
  66         </variablelist>
  67     </refsect1>
  68     <refsect1 id="description"><title>Description</title>
  69         <para>
  70             <function>glXQueryContext</function> sets <parameter>value</parameter> to the value of <parameter>attribute</parameter> with respect to <parameter>ctx</parameter>.
  71             <parameter>attribute</parameter> may be one of the following:
  72         </para>
  73         <variablelist>
  74             <varlistentry>
  75                 <term><constant>GLX_FBCONFIG_ID</constant></term>
  76                 <listitem>
  77                     <para>
  78                         Returns the XID of the GLXFBConfig associated with <parameter>ctx</parameter>.
  79                     </para>
  80                 </listitem>
  81             </varlistentry>
  82             <varlistentry>
  83                 <term><constant>GLX_RENDER_TYPE</constant></term>
  84                 <listitem>
  85                     <para>
  86                         Returns the rendering type supported by <parameter>ctx</parameter>.
  87                     </para>
  88                 </listitem>
  89             </varlistentry>
  90             <varlistentry>
  91                 <term><constant>GLX_SCREEN</constant></term>
  92                 <listitem>
  93                     <para>
  94                         Returns the screen number associated with <parameter>ctx</parameter>.
  95                     </para>
  96                 </listitem>
  97             </varlistentry>
  98         </variablelist>
  99         <para>
 100             <constant>Success</constant> is returned unless <parameter>attribute</parameter> is not a valid GLX
 101             context attribute, in which case <constant>GLX_BAD_ATTRIBUTE</constant> is returned.
 102         </para>
 103         <para>
 104             This call may cause a round-trip to the server.
 105         </para>
 106     </refsect1>
 107     <refsect1 id="notes"><title>Notes</title>
 108         <para>
 109             <function>glXQueryContext</function> is available only if the GLX version is 1.3 or greater.
 110         </para>
 111         <para>
 112             If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
 113             If the GLX version is 1.2, then the GL version must be 1.1.
 114             If the GLX version is 1.3, then the GL version must be 1.2.
 115         </para>
 116     </refsect1>
 117     <refsect1 id="errors"><title>Errors</title>
 118         <para>
 119             <constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> does not
 120             refer to a valid context.
 121         </para>
 122     </refsect1>
 123     <refsect1 id="seealso"><title>See Also</title>
 124         <para>
 125             <citerefentry><refentrytitle>glXCreateNewContext</refentrytitle></citerefentry>,
 126             <citerefentry><refentrytitle>glXGetCurrentContext</refentrytitle></citerefentry>,
 127             <citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>,
 128             <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>
 129         </para>
 130     </refsect1>
 131     <refsect1 id="Copyright"><title>Copyright</title>
 132         <para>
 133             Copyright <trademark class="copyright"></trademark> 1991-2006
 134             Silicon Graphics, Inc. This document is licensed under the SGI
 135             Free Software B License. For details, see
 136             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 137         </para>
 138     </refsect1>
 139 </refentry>