upstream-doc/man2/glXQueryDrawable.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="glXQueryDrawable">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXQueryDrawable</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXQueryDrawable</refname>
  17         <refpurpose>returns an attribute assoicated with a GLX drawable</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>int <function>glXQueryDrawable</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>GLXDrawable <parameter>draw</parameter></paramdef>
  25                 <paramdef>int <parameter>attribute</parameter></paramdef>
  26                 <paramdef>unsigned 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>draw</parameter></term>
  43             <listitem>
  44                 <para>
  45                     Specifies the GLX drawable to be queried.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         <varlistentry>
  50             <term><parameter>attribute</parameter></term>
  51             <listitem>
  52                 <para>
  53                     Specifies the attribute to be returned.  Must be one of
  54                     <constant>GLX_WIDTH</constant>,
  55                                         <constant>GLX_HEIGHT</constant>,
  56                                         <constant>GLX_PRESERVED_CONTENTS</constant>,
  57                                         <constant>GLX_LARGEST_PBUFFER</constant>, or
  58                                         <constant>GLX_FBCONFIG_ID</constant>.
  59                 </para>
  60             </listitem>
  61         </varlistentry>
  62         <varlistentry>
  63             <term><parameter>value</parameter></term>
  64             <listitem>
  65                 <para>
  66                     Contains the return value for
  67                                         <parameter>attribute</parameter>.
  68                 </para>
  69             </listitem>
  70         </varlistentry>
  71         </variablelist>
  72     </refsect1>
  73     <refsect1 id="description"><title>Description</title>
  74         <para>
  75             <function>glXQueryDrawable</function> sets
  76                         <parameter>value</parameter> to the value of
  77                         <parameter>attribute</parameter> with respect to the GLXDrawable
  78                         <parameter>draw</parameter>.
  79                 </para>
  80                 <para>
  81             <parameter>attribute</parameter> may be one of the following:
  82         </para>
  83         <variablelist>
  84             <varlistentry>
  85                 <term><constant>GLX_WIDTH</constant></term>
  86                 <listitem>
  87                     <para>
  88                         Returns the width of <parameter>ctx</parameter>.
  89                     </para>
  90                 </listitem>
  91             </varlistentry>
  92             <varlistentry>
  93                 <term><constant>GLX_HEIGHT</constant></term>
  94                 <listitem>
  95                     <para>
  96                         Returns the height of <parameter>ctx</parameter>.
  97                     </para>
  98                 </listitem>
  99             </varlistentry>
 100             <varlistentry>
 101                 <term><constant>GLX_PRESERVED_CONTENTS</constant></term>
 102                 <listitem>
 103                     <para>
 104                         Returns <constant>True</constant> if the contents
 105                                                 of a GLXPbuffer are preserved when a resource
 106                                                 conflict occurs; <constant>False</constant> otherwise.
 107                     </para>
 108                 </listitem>
 109             </varlistentry>
 110             <varlistentry>
 111                 <term><constant>GLX_LARGEST_PBUFFER</constant></term>
 112                 <listitem>
 113                     <para>
 114                         Returns the value set when
 115                         <function>glXCreatePbuffer</function> was called to
 116                         create the GLXPbuffer. If
 117                         <constant>False</constant> is returned, then the
 118                         call to <function>glXCreatePbuffer</function> will
 119                         fail to create a GLXPbuffer if the requested size
 120                         is larger than the implementation maximum or
 121                         available resources.  If <constant>True</constant>
 122                         is returned, a GLXPbuffer of the maximum availble
 123                         size (if less than the requested width and height)
 124                         is created.
 125                     </para>
 126                 </listitem>
 127             </varlistentry>
 128                         <varlistentry>
 129                             <term><constant>GLX_FBCONFIG_ID</constant></term>
 130                                 <listitem>
 131                                     <para>
 132                                             Returns the XID for <parameter>draw</parameter>.
 133                                         </para>
 134                                 </listitem>
 135                         </varlistentry>
 136         </variablelist>
 137         <para>
 138             If <parameter>draw</parameter> is a GLXWindow or GLXPixmap and
 139             <parameter>attribute</parameter> is set to
 140             <constant>GLX_PRESERVED_CONTENTS</constant> or
 141             <constant>GLX_LARGETST_PBUFFER</constant>, the contents of
 142             <parameter>value</parameter> are undefined.  If
 143             <parameter>attribute</parameter> is not one of the attributes
 144             listed above, the contents of <parameter>value</parameter> are
 145             unedfined.
 146         </para>
 147     </refsect1>
 148     <refsect1 id="errors"><title>Errors</title>
 149         <para>
 150             A <constant>GLXBadDrawable</constant> is generated if
 151                         <parameter>draw</parameter> is not a valid GLXDrawable.
 152         </para>
 153     </refsect1>
 154     <refsect1 id="seealso"><title>See Also</title>
 155         <para>
 156                     <citerefentry><refentrytitle>glXCreateWindow</refentrytitle></citerefentry>,
 157                         <citerefentry><refentrytitle>glXCreatePixmap</refentrytitle></citerefentry>,
 158                         <citerefentry><refentrytitle>glXCreatePbuffer</refentrytitle></citerefentry>,
 159                         <citerefentry><refentrytitle>glXGetFBConfigAttrib</refentrytitle></citerefentry>,
 160                         <citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry>
 161         </para>
 162     </refsect1>
 163     <refsect1 id="Copyright"><title>Copyright</title>
 164         <para>
 165             Copyright <trademark class="copyright"></trademark> 1991-2006
 166             Silicon Graphics, Inc. This document is licensed under the SGI
 167             Free Software B License. For details, see
 168             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 169         </para>
 170     </refsect1>
 171 </refentry>