upstream-doc/man2/xhtml/glXGetClientString.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>glXGetClientString</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glXGetClientString"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glXGetClientString — return a string describing the client</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 char * <b class="fsfunc">glXGetClientString</b>(</code></td><td>Display *  </td><td><var class="pdparam">dpy</var>, </td></tr><tr><td> </td><td>int  </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>dpy</code></em></span></dt><dd><p>
   4                     Specifies the connection to the X server.
   5                 </p></dd><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
   6                     Specifies which string is returned.
   7                     The symbolic constants <code class="constant">GLX_VENDOR</code>, <code class="constant">GLX_VERSION</code>,
   8                     and <code class="constant">GLX_EXTENSIONS</code> are accepted.
   9                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  10             <code class="function">glXGetClientString</code> returns a string
  11             describing some aspect of the client library. The possible values for <em class="parameter"><code>name</code></em>
  12             are <code class="constant">GLX_VENDOR</code>, <code class="constant">GLX_VERSION</code>, and
  13             <code class="constant">GLX_EXTENSIONS</code>. If <em class="parameter"><code>name</code></em>
  14             is not set to one of these values, <code class="function">glXGetClientString</code> returns <code class="constant">NULL</code>.
  15             The format and contents of the vendor string is implementation dependent.
  16         </p><p>
  17             The extensions string is null-terminated and contains a
  18             space-separated list of  extension names. (The extension names never
  19             contain spaces.)
  20             If there are no extensions to GLX, then the empty string is returned.
  21         </p><p>
  22             The version string is laid out as follows:
  23         </p><p>
  24             &lt;major_version.minor_version&gt;&lt;space&gt;&lt;vendor-specific info&gt;
  25         </p><p>
  26             Both the major and minor portions of the version number are of arbitrary
  27             length.  The vendor-specific information is optional.  However, if it is
  28             present, the format and contents are implementation specific.
  29         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  30             <code class="function">glXGetClientString</code> is available only if the GLX version is 1.1 or greater.
  31         </p><p>
  32             If the GLX version is 1.1 or 1.0, the GL version must be 1.0.
  33             If the GLX version is 1.2, then the GL version must be 1.1.
  34             If the GLX version is 1.3, then the GL version must be 1.2.
  35         </p><p>
  36             <code class="function">glXGetClientString</code> only returns information about GLX extensions supported by the client.
  37             Call <a class="citerefentry" href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a> to get a list of GL extensions supported by the server.
  38         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  39             <a class="citerefentry" href="glXQueryVersion.xml"><span class="citerefentry"><span class="refentrytitle">glXQueryVersion</span></span></a>,
  40             <a class="citerefentry" href="glXQueryExtensionsString.xml"><span class="citerefentry"><span class="refentrytitle">glXQueryExtensionsString</span></span></a>,
  41             <a class="citerefentry" href="glXQueryServerString.xml"><span class="citerefentry"><span class="refentrytitle">glXQueryServerString</span></span></a>
  42         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  43             Copyright <span class="trademark"></span>© 1991-2006
  44             Silicon Graphics, Inc. This document is licensed under the SGI
  45             Free Software B License. For details, see
  46             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  47         </p></div></div></body></html>