upstream-man-pages/man2/gluGetString.xml

   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="gluGetString">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluGetString</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluGetString</refname>
  17         <refpurpose>return a string describing the GLU version or GLU extensions </refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>const GLubyte * <function>gluGetString</function></funcdef>
  23                 <paramdef>GLenum <parameter>name</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>name</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies a symbolic constant, one of
  34                     <constant>GLU_VERSION</constant>, or <constant>GLU_EXTENSIONS</constant>.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>gluGetString</function> returns a pointer to a static string describing the
  43             GLU version or the GLU extensions that are supported.
  44         </para>
  45         <para>
  46             The version number is one of the following
  47             forms:
  48         </para>
  49         <para>
  50             <emphasis>major_number.minor_number</emphasis>
  51             <emphasis>major_number.minor_number.release_number</emphasis>.
  52         </para>
  53         <para>
  54             The version string is of the following form:
  55         </para>
  56         <para>
  57             <emphasis>version number&lt;space&gt;vendor-specific information</emphasis>
  58         </para>
  59         <para>
  60             Vendor-specific information is optional.
  61             Its format and contents depend on the implementation.
  62         </para>
  63         <para>
  64             The standard GLU contains a basic set of features and capabilities.
  65             If a company or group of companies wish to support other features,
  66             these may be included as extensions to the GLU.
  67             If <parameter>name</parameter> is
  68             <constant>GLU_EXTENSIONS</constant>, then <function>gluGetString</function>
  69             returns a space-separated list of names of supported GLU extensions.
  70             (Extension names never contain spaces.)
  71         </para>
  72         <para>
  73             All strings are null-terminated.
  74         </para>
  75     </refsect1>
  76     <refsect1 id="notes"><title>Notes</title>
  77         <para>
  78             <function>gluGetString</function> only returns information about GLU extensions. Call <function>glGetString</function>
  79              to get a list of GL extensions.
  80         </para>
  81         <para>
  82             <function>gluGetString</function> is an initialization routine. Calling it after
  83             a <citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry> results in undefined behavior.
  84         </para>
  85     </refsect1>
  86     <refsect1 id="errors"><title>Errors</title>
  87         <para>
  88             NULL is returned if <parameter>name</parameter> is not
  89             <constant>GLU_VERSION</constant> or <constant>GLU_EXTENSIONS</constant>.
  90         </para>
  91         <para>
  92         </para>
  93     </refsect1>
  94     <refsect1 id="seealso"><title>See Also</title>
  95         <para>
  96             <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>
  97         </para>
  98     </refsect1>
  99     <refsect1 id="Copyright"><title>Copyright</title>
 100         <para>
 101             Copyright <trademark class="copyright"></trademark> 1991-2006
 102             Silicon Graphics, Inc. This document is licensed under the SGI
 103             Free Software B License. For details, see
 104             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 105         </para>
 106     </refsect1>
 107 </refentry>