rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / glXIsDirect.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="glXIsDirect">
5 <refmeta>
6 <refmetainfo>
7 <copyright>
8 <year>1991-2006</year>
9 <holder>Silicon Graphics, Inc.</holder>
10 </copyright>
11 </refmetainfo>
12 <refentrytitle>glXIsDirect</refentrytitle>
13 <manvolnum>3G</manvolnum>
14 </refmeta>
15 <refnamediv>
16 <refname>glXIsDirect</refname>
17 <refpurpose>indicate whether direct rendering is enabled</refpurpose>
18 </refnamediv>
19 <refsynopsisdiv><title>C Specification</title>
20 <funcsynopsis>
21 <funcprototype>
22 <funcdef>Bool <function>glXIsDirect</function></funcdef>
23 <paramdef>Display * <parameter>dpy</parameter></paramdef>
24 <paramdef>GLXContext <parameter>ctx</parameter></paramdef>
25 </funcprototype>
26 </funcsynopsis>
27 </refsynopsisdiv>
28 <!-- eqn: ignoring delim $$ -->
29 <refsect1 id="parameters"><title>Parameters</title>
30 <variablelist>
31 <varlistentry>
32 <term><parameter>dpy</parameter></term>
33 <listitem>
34 <para>
35 Specifies the connection to the X server.
36 </para>
37 </listitem>
38 </varlistentry>
39 <varlistentry>
40 <term><parameter>ctx</parameter></term>
41 <listitem>
42 <para>
43 Specifies the GLX context that is being queried.
44 </para>
45 </listitem>
46 </varlistentry>
47 </variablelist>
48 </refsect1>
49 <refsect1 id="description"><title>Description</title>
50 <para>
51 <function>glXIsDirect</function> returns <constant>True</constant> if <parameter>ctx</parameter> is a direct rendering context,
52 <constant>False</constant> otherwise.
53 Direct rendering contexts pass rendering commands directly from the calling
54 process's address space to the rendering system,
55 bypassing the X server.
56 Nondirect rendering contexts pass all rendering commands to the X server.
57 </para>
58 </refsect1>
59 <refsect1 id="errors"><title>Errors</title>
60 <para>
61 <constant>GLXBadContext</constant> is generated if <parameter>ctx</parameter> is not a valid GLX context.
62 </para>
63 </refsect1>
64 <refsect1 id="seealso"><title>See Also</title>
65 <para>
66 <citerefentry><refentrytitle>glXCreateContext</refentrytitle></citerefentry>,
67 <citerefentry><refentrytitle>glXCreateNewContext</refentrytitle></citerefentry>
68 </para>
69 </refsect1>
70 <refsect1 id="Copyright"><title>Copyright</title>
71 <para>
72 Copyright <trademark class="copyright"></trademark> 1991-2006
73 Silicon Graphics, Inc. This document is licensed under the SGI
74 Free Software B License. For details, see
75 <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
76 </para>
77 </refsect1>
78</refentry>