include more low-level bindings
[clinton/guile-figl.git] / upstream-man-pages / man2 / xhtml / gluGetString.xml
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
2 <!-- saved from url=(0013)about:internet -->
3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>gluGetString</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="gluGetString"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>gluGetString — return a string describing the GLU version or GLU extensions </p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">const GLubyte * <b class="fsfunc">gluGetString</b>(</code></td><td>GLenum  </td><td><var class="pdparam">name</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
4 Specifies a symbolic constant, one of
5 <code class="constant">GLU_VERSION</code>, or <code class="constant">GLU_EXTENSIONS</code>.
6 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
7 <code class="function">gluGetString</code> returns a pointer to a static string describing the
8 GLU version or the GLU extensions that are supported.
9 </p><p>
10 The version number is one of the following
11 forms:
12 </p><p>
13 <span class="emphasis"><em>major_number.minor_number</em></span>
14 <span class="emphasis"><em>major_number.minor_number.release_number</em></span>.
15 </p><p>
16 The version string is of the following form:
17 </p><p>
18 <span class="emphasis"><em>version number&lt;space&gt;vendor-specific information</em></span>
19 </p><p>
20 Vendor-specific information is optional.
21 Its format and contents depend on the implementation.
22 </p><p>
23 The standard GLU contains a basic set of features and capabilities.
24 If a company or group of companies wish to support other features,
25 these may be included as extensions to the GLU.
26 If <em class="parameter"><code>name</code></em> is
27 <code class="constant">GLU_EXTENSIONS</code>, then <code class="function">gluGetString</code>
28 returns a space-separated list of names of supported GLU extensions.
29 (Extension names never contain spaces.)
30 </p><p>
31 All strings are null-terminated.
32 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
33 <code class="function">gluGetString</code> only returns information about GLU extensions. Call <code class="function">glGetString</code>
34 to get a list of GL extensions.
35 </p><p>
36 <code class="function">gluGetString</code> is an initialization routine. Calling it after
37 a <a class="citerefentry" href="glNewList.xml"><span class="citerefentry"><span class="refentrytitle">glNewList</span></span></a> results in undefined behavior.
38 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
39 NULL is returned if <em class="parameter"><code>name</code></em> is not
40 <code class="constant">GLU_VERSION</code> or <code class="constant">GLU_EXTENSIONS</code>.
41 </p><p>
42 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
43 <a class="citerefentry" href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>
44 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
45 Copyright <span class="trademark"></span>© 1991-2006
46 Silicon Graphics, Inc. This document is licensed under the SGI
47 Free Software B License. For details, see
48 <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
49 </p></div></div></body></html>