upstream-man-pages/man2/glXCreatePixmap.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="glXCreatePixmap">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXCreatePixmap</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXCreatePixmap</refname>
  17         <refpurpose>create an off-screen rendering area</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>GLXPixmap <function>glXCreatePixmap</function></funcdef>
  23                 <paramdef>Display * <parameter>dpy</parameter></paramdef>
  24                 <paramdef>GLXFBConfig <parameter>config</parameter></paramdef>
  25                 <paramdef>Pixmap <parameter>pixmap</parameter></paramdef>
  26                 <paramdef>const int * <parameter>attrib_list</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>config</parameter></term>
  43             <listitem>
  44                 <para>
  45                     Specifies a GLXFBConfig structure with the desired attributes for the
  46                     window.
  47                 </para>
  48             </listitem>
  49         </varlistentry>
  50         <varlistentry>
  51             <term><parameter>pixmap</parameter></term>
  52             <listitem>
  53                 <para>
  54                     Specifies the X pixmap to be used as the rendering area.
  55                 </para>
  56             </listitem>
  57         </varlistentry>
  58         <varlistentry>
  59             <term><parameter>attrib_list</parameter></term>
  60             <listitem>
  61                 <para>
  62                     Currently unused. This must be set to <constant>NULL</constant> or be an empty list
  63                     (i.e., one in which the first element is <constant>None</constant>).
  64                 </para>
  65             </listitem>
  66         </varlistentry>
  67         </variablelist>
  68     </refsect1>
  69     <refsect1 id="description"><title>Description</title>
  70         <para>
  71             <function>glXCreatePixmap</function> creates an off-screen rendering area and returns its XID.
  72             Any GLX rendering context that was created with respect to <parameter>config</parameter>
  73             can be used to render into this window.
  74             Use <citerefentry><refentrytitle>glXMakeCurrent</refentrytitle></citerefentry> to associate the rendering area with a GLX
  75             rendering context.
  76         </para>
  77     </refsect1>
  78     <refsect1 id="notes"><title>Notes</title>
  79         <para>
  80             <function>glXCreatePixmap</function> is available only if the GLX version is 1.3 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     </refsect1>
  88     <refsect1 id="errors"><title>Errors</title>
  89         <para>
  90             <constant>BadMatch</constant> is generated if <parameter>pixmap</parameter> was not created with a visual
  91             that corresponds to <parameter>config</parameter>.
  92         </para>
  93         <para>
  94             <constant>BadMatch</constant> is generated if <parameter>config</parameter> does not support rendering to
  95             windows (e.g., <constant>GLX_DRAWABLE_TYPE</constant> does not contain
  96             <constant>GLX_WINDOW_BIT</constant>).
  97         </para>
  98         <para>
  99             <constant>BadWindow</constant> is generated if <parameter>pixmap</parameter> is not a valid window XID.
 100             <constant>BadAlloc</constant> is generated if there is already a GLXFBConfig
 101             associated with <parameter>pixmap</parameter>.
 102         </para>
 103         <para>
 104             <constant>BadAlloc</constant> is generated if the X server cannot allocate a new
 105             GLX window.
 106         </para>
 107         <para>
 108             <constant>GLXBadFBConfig</constant> is generated if <parameter>config</parameter> is not a valid
 109             GLXFBConfig.
 110         </para>
 111         <para>
 112         </para>
 113     </refsect1>
 114     <refsect1 id="seealso"><title>See Also</title>
 115         <para>
 116             <citerefentry><refentrytitle>glXChooseFBConfig</refentrytitle></citerefentry>,
 117             <citerefentry><refentrytitle>glXCreateGLXPixmap</refentrytitle></citerefentry>,
 118             <citerefentry><refentrytitle>glXDestroyWindow</refentrytitle></citerefentry>,
 119             <citerefentry><refentrytitle>glXMakeContextCurrent</refentrytitle></citerefentry>
 120         </para>
 121     </refsect1>
 122     <refsect1 id="Copyright"><title>Copyright</title>
 123         <para>
 124             Copyright <trademark class="copyright"></trademark> 1991-2006
 125             Silicon Graphics, Inc. This document is licensed under the SGI
 126             Free Software B License. For details, see
 127             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 128         </para>
 129     </refsect1>
 130 </refentry>