rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / glXGetCurrentReadDrawable.xml
CommitLineData
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="glXGetCurrentReadDrawable">
5 <refmeta>
6 <refmetainfo>
7 <copyright>
8 <year>1991-2006</year>
9 <holder>Silicon Graphics, Inc.</holder>
10 </copyright>
11 </refmetainfo>
12 <refentrytitle>glXGetCurrentReadDrawable</refentrytitle>
13 <manvolnum>3G</manvolnum>
14 </refmeta>
15 <refnamediv>
16 <refname>glXGetCurrentReadDrawable</refname>
17 <refpurpose>return the current drawable</refpurpose>
18 </refnamediv>
19 <refsynopsisdiv><title>C Specification</title>
20 <funcsynopsis>
21 <funcprototype>
22 <funcdef>GLXDrawable <function>glXGetCurrentReadDrawable</function></funcdef>
23 </funcprototype>
24 </funcsynopsis>
25 </refsynopsisdiv>
26 <refsect1 id="description"><title>Description</title>
27 <para>
28 <function>glXGetCurrentReadDrawable</function> returns the current read drawable,
29 as specified by <constant>read</constant> parameter
30 of <citerefentry><refentrytitle>glXMakeContextCurrent</refentrytitle></citerefentry>.
31 If there is no current drawable,
32 <constant>None</constant> is returned.
33 </para>
34 <para>
35 <function>glXGetCurrentReadDrawable</function> returns client-side information.
36 It does not make a round-trip to the server.
37 </para>
38 </refsect1>
39 <refsect1 id="notes"><title>Notes</title>
40 <para>
41 <function>glXGetCurrentReadDrawable</function> is only supported if the GLX version is 1.3 or greater.
42 </para>
43 </refsect1>
44 <refsect1 id="seealso"><title>See Also</title>
45 <para>
46 <citerefentry><refentrytitle>glXGetCurrentContext</refentrytitle></citerefentry>,
47 <citerefentry><refentrytitle>glXGetCurrentDisplay</refentrytitle></citerefentry>,
48 <citerefentry><refentrytitle>glXGetCurrentDrawable</refentrytitle></citerefentry>,
49 <citerefentry><refentrytitle>glXMakeContextCurrent</refentrytitle></citerefentry>
50 </para>
51 </refsect1>
52 <refsect1 id="Copyright"><title>Copyright</title>
53 <para>
54 Copyright <trademark class="copyright"></trademark> 1991-2006
55 Silicon Graphics, Inc. This document is licensed under the SGI
56 Free Software B License. For details, see
57 <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
58 </para>
59 </refsect1>
60</refentry>