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

78 lines
3.1 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="glXIsDirect">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXIsDirect</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXIsDirect</refname>
<refpurpose>indicate whether direct rendering is enabled</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>Bool <function>glXIsDirect</function></funcdef>
<paramdef>Display * <parameter>dpy</parameter></paramdef>
<paramdef>GLXContext <parameter>ctx</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<!-- eqn: ignoring delim $$ -->
<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>ctx</parameter></term>
<listitem>
<para>
Specifies the GLX context that is being queried.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glXIsDirect</function> returns <constant>True</constant> if <parameter>ctx</parameter> is a direct rendering context,
<constant>False</constant> otherwise.
Direct rendering contexts pass rendering commands directly from the calling
process's address space to the rendering system,
bypassing the X server.
Nondirect rendering contexts pass all rendering commands to the X server.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> is not a valid GLX context.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glXCreateContext</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glXCreateNewContext</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>