Opentk/Source/Bind/Specifications/Docs/glXGetSelectedEvent.xml
2009-03-08 00:46:58 +00:00

93 lines
3.7 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glXGetSelectedEvent">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXGetSelectedEvent</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXGetSelectedEvent</refname>
<refpurpose>returns GLX events that are selected for a window or a GLX pixel buffer</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glXGetSelectedEvent</function></funcdef>
<paramdef>Display * <parameter>dpy</parameter></paramdef>
<paramdef>GLXDrawable <parameter>draw</parameter></paramdef>
<paramdef>unsigned long * <parameter>event_mask</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>dpy</parameter></term>
<listitem>
<para>
Specifies the connection to the X server.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>draw</parameter></term>
<listitem>
<para>
Specifies a GLX drawable. Must be a GLX pixel buffer or a window.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>event_mask</parameter></term>
<listitem>
<para>
Returns the events that are selected for <parameter>draw</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glXGetSelectedEvent</function> returns in <parameter>event_mask</parameter> the events selected for <parameter>draw</parameter>.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>glXGetSelectedEvent</function> is available only if the GLX version is 1.3 or greater.
</para>
<para>
If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
If the GLX version is 1.2, then the GL version must be 1.1.
If the GLX version is 1.3, then the GL version must be 1.2.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GLXBadDrawable</constant> is generated if <parameter>draw</parameter> is not a valid window
or a valid GLX pixel buffer.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glXSelectEvent</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXCreatePbuffer</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
</para>
</refsect1>
</refentry>