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

60 lines
2.6 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="glXGetCurrentReadDrawable">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXGetCurrentReadDrawable</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXGetCurrentReadDrawable</refname>
<refpurpose>return the current drawable</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLXDrawable <function>glXGetCurrentReadDrawable</function></funcdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="description"><title>Description</title>
<para>
<function>glXGetCurrentReadDrawable</function> returns the current read drawable,
as specified by <constant>read</constant> parameter
of <citerefentry><refentrytitle>glXMakeContextCurrent</refentrytitle></citerefentry>.
If there is no current drawable,
<constant>None</constant> is returned.
</para>
<para>
<function>glXGetCurrentReadDrawable</function> returns client-side information.
It does not make a round-trip to the server.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>glXGetCurrentReadDrawable</function> is only supported if the GLX version is 1.3 or greater.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glXGetCurrentContext</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXGetCurrentDisplay</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXGetCurrentDrawable</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXMakeContextCurrent</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>