<?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="gluGetString">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>1991-2006</year>
                <holder>Silicon Graphics, Inc.</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>gluGetString</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>gluGetString</refname>
        <refpurpose>return a string describing the GLU version or GLU extensions </refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>const GLubyte * <function>gluGetString</function></funcdef>
                <paramdef>GLenum <parameter>name</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>name</parameter></term>
            <listitem>
                <para>
                    Specifies a symbolic constant, one of 
                    <constant>GLU_VERSION</constant>, or <constant>GLU_EXTENSIONS</constant>.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>gluGetString</function> returns a pointer to a static string describing the 
            GLU version or the GLU extensions that are supported.
        </para>
        <para>
            The version number is one of the following
            forms: 
        </para>
        <para>
            <emphasis>major_number.minor_number</emphasis>  
            <emphasis>major_number.minor_number.release_number</emphasis>. 
        </para>
        <para>
            The version string is of the following form: 
        </para>
        <para>
            <emphasis>version number&lt;space&gt;vendor-specific information</emphasis>
        </para>
        <para>
            Vendor-specific information is optional.
            Its format and contents depend on the implementation.
        </para>
        <para>
            The standard GLU contains a basic set of features and capabilities.
            If a company or group of companies wish to support other features,
            these may be included as extensions to the GLU.  
            If <parameter>name</parameter> is 
            <constant>GLU_EXTENSIONS</constant>, then <function>gluGetString</function>
            returns a space-separated list of names of supported GLU extensions.
            (Extension names never contain spaces.)
        </para>
        <para>
            All strings are null-terminated.
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            <function>gluGetString</function> only returns information about GLU extensions. Call <function>glGetString</function>
             to get a list of GL extensions.
        </para>
        <para>
            <function>gluGetString</function> is an initialization routine. Calling it after
            a <citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry> results in undefined behavior.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            NULL is returned if <parameter>name</parameter> is not
            <constant>GLU_VERSION</constant> or <constant>GLU_EXTENSIONS</constant>.
        </para>
        <para>
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glGetString</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>
