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

93 lines
3.8 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="glXQueryVersion">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glXQueryVersion</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glXQueryVersion</refname>
<refpurpose>return the version numbers of the GLX extension</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>Bool <function>glXQueryVersion</function></funcdef>
<paramdef>Display * <parameter>dpy</parameter></paramdef>
<paramdef>int * <parameter>major</parameter></paramdef>
<paramdef>int * <parameter>minor</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>major</parameter></term>
<listitem>
<para>
Returns the major version number of the GLX server extension.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>minor</parameter></term>
<listitem>
<para>
Returns the minor version number of the GLX server extension.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glXQueryVersion</function> returns the major and minor version numbers of the GLX extension
implemented by the server associated with connection <parameter>dpy</parameter>.
Implementations with the same major version number are upward compatible,
meaning that the implementation with the higher minor number is a superset
of the version with the lower minor number.
</para>
<para>
<parameter>major</parameter> and <parameter>minor</parameter> do not return values if they are specified as
<constant>NULL</constant>.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<function>glXQueryVersion</function> returns <constant>False</constant> if it fails,
<constant>True</constant> otherwise.
</para>
<para>
<parameter>major</parameter> and <parameter>minor</parameter> are not updated when <constant>False</constant> is returned.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glXQueryExtension</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>