HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
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="glXGetSelectedEvent"> | |
| 5 | <refmeta> | |
| 6 | <refmetainfo> | |
| 7 | <copyright> | |
| 8 | <year>1991-2006</year> | |
| 9 | <holder>Silicon Graphics, Inc.</holder> | |
| 10 | </copyright> | |
| 11 | </refmetainfo> | |
| 12 | <refentrytitle>glXGetSelectedEvent</refentrytitle> | |
| 13 | <manvolnum>3G</manvolnum> | |
| 14 | </refmeta> | |
| 15 | <refnamediv> | |
| 16 | <refname>glXGetSelectedEvent</refname> | |
| 17 | <refpurpose>returns GLX events that are selected for a window or a GLX pixel buffer</refpurpose> | |
| 18 | </refnamediv> | |
| 19 | <refsynopsisdiv><title>C Specification</title> | |
| 20 | <funcsynopsis> | |
| 21 | <funcprototype> | |
| 22 | <funcdef>void <function>glXGetSelectedEvent</function></funcdef> | |
| 23 | <paramdef>Display * <parameter>dpy</parameter></paramdef> | |
| 24 | <paramdef>GLXDrawable <parameter>draw</parameter></paramdef> | |
| 25 | <paramdef>unsigned long * <parameter>event_mask</parameter></paramdef> | |
| 26 | </funcprototype> | |
| 27 | </funcsynopsis> | |
| 28 | </refsynopsisdiv> | |
| 29 | <refsect1 id="parameters"><title>Parameters</title> | |
| 30 | <variablelist> | |
| 31 | <varlistentry> | |
| 32 | <term><parameter>dpy</parameter></term> | |
| 33 | <listitem> | |
| 34 | <para> | |
| 35 | Specifies the connection to the X server. | |
| 36 | </para> | |
| 37 | </listitem> | |
| 38 | </varlistentry> | |
| 39 | <varlistentry> | |
| 40 | <term><parameter>draw</parameter></term> | |
| 41 | <listitem> | |
| 42 | <para> | |
| 43 | Specifies a GLX drawable. Must be a GLX pixel buffer or a window. | |
| 44 | </para> | |
| 45 | </listitem> | |
| 46 | </varlistentry> | |
| 47 | <varlistentry> | |
| 48 | <term><parameter>event_mask</parameter></term> | |
| 49 | <listitem> | |
| 50 | <para> | |
| 51 | Returns the events that are selected for <parameter>draw</parameter>. | |
| 52 | </para> | |
| 53 | </listitem> | |
| 54 | </varlistentry> | |
| 55 | </variablelist> | |
| 56 | </refsect1> | |
| 57 | <refsect1 id="description"><title>Description</title> | |
| 58 | <para> | |
| 59 | <function>glXGetSelectedEvent</function> returns in <parameter>event_mask</parameter> the events selected for <parameter>draw</parameter>. | |
| 60 | </para> | |
| 61 | </refsect1> | |
| 62 | <refsect1 id="notes"><title>Notes</title> | |
| 63 | <para> | |
| 64 | <function>glXGetSelectedEvent</function> is available only if the GLX version is 1.3 or greater. | |
| 65 | </para> | |
| 66 | <para> | |
| 67 | If the GLX version is 1.1 or 1.0, the GL version must be 1.0. | |
| 68 | If the GLX version is 1.2, then the GL version must be 1.1. | |
| 69 | If the GLX version is 1.3, then the GL version must be 1.2. | |
| 70 | </para> | |
| 71 | </refsect1> | |
| 72 | <refsect1 id="errors"><title>Errors</title> | |
| 73 | <para> | |
| 74 | <constant>GLXBadDrawable</constant> is generated if <parameter>draw</parameter> is not a valid window | |
| 75 | or a valid GLX pixel buffer. | |
| 76 | </para> | |
| 77 | </refsect1> | |
| 78 | <refsect1 id="seealso"><title>See Also</title> | |
| 79 | <para> | |
| 80 | <citerefentry><refentrytitle>glXSelectEvent</refentrytitle></citerefentry>, | |
| 81 | <citerefentry><refentrytitle>glXCreatePbuffer</refentrytitle></citerefentry> | |
| 82 | </para> | |
| 83 | </refsect1> | |
| 84 | <refsect1 id="Copyright"><title>Copyright</title> | |
| 85 | <para> | |
| 86 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
| 87 | Silicon Graphics, Inc. This document is licensed under the SGI | |
| 88 | Free Software B License. For details, see | |
| 89 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
| 90 | </para> | |
| 91 | </refsect1> | |
| 92 | </refentry> |