Opentk/Source/Bind/Specifications/Docs/GL/glXGetContextIDEXT.xml

78 lines
3.3 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="glXGetContextIDEXT">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXGetContextIDEXT</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXGetContextIDEXT</refname>
<refpurpose>get the XID for a context.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>GLXContextID <function>glXGetContextIDEXT</function></funcdef>
<paramdef>const GLXContext <parameter>ctx</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- eqn: ignoring delim $$ -->
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>ctx</parameter></term>
<listitem>
<para>
Specifies a GLX rendering context.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glXGetContextIDEXT</function> returns the XID associated with a GLXContext.
</para>
<para>
No round trip is forced to the server; unlike most X calls that
return a value, <function>glXGetContextIDEXT</function> does not flush any pending events.
</para>
<para>
<function>glXGetContextIDEXT</function> is part of the <code>EXT_import_context</code> extension,
not part of the core GLX command set. If _glxextstring(EXT_import_context)
is included in the string returned by <citerefentry><refentrytitle>glXQueryExtensionsString</refentrytitle></citerefentry>,
when called with argument <constant>GLX_EXTENSIONS</constant>,
extension <code>EXT_import_context</code> is supported.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> does not
refer to a valid context.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glXCreateContext</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXQueryVersion</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXQueryExtensionsString</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>