upstream-man-pages/man3/glGetString.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="glGetString">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGetString</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGetString</refname>
  17         <refpurpose>return a string describing the current GL connection</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>const GLubyte* <function>glGetString</function></funcdef>
  23                 <paramdef>GLenum <parameter>name</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsynopsisdiv><title>C Specification</title>
  28         <funcsynopsis>
  29             <funcprototype>
  30                 <funcdef>const GLubyte* <function>glGetStringi</function></funcdef>
  31                 <paramdef>GLenum <parameter>name</parameter></paramdef>
  32                 <paramdef>GLuint <parameter>index</parameter></paramdef>
  33             </funcprototype>
  34         </funcsynopsis>
  35     </refsynopsisdiv>
  36     <refsect1 id="parameters"><title>Parameters</title>
  37         <variablelist>
  38         <varlistentry>
  39             <term><parameter>name</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies a symbolic constant, one of
  43                     <constant>GL_VENDOR</constant>, <constant>GL_RENDERER</constant>,
  44                     <constant>GL_VERSION</constant>, or <constant>GL_SHADING_LANGUAGE_VERSION</constant>.
  45                     Additionally, <function>glGetStringi</function> accepts the <constant>GL_EXTENSIONS</constant> token.
  46                 </para>
  47             </listitem>
  48         </varlistentry>
  49         <varlistentry>
  50             <term><parameter>index</parameter></term>
  51             <listitem>
  52                 <para>
  53                     For <function>glGetStringi</function>, specifies the index of the string to return.
  54                 </para>
  55             </listitem>
  56         </varlistentry>
  57         </variablelist>
  58     </refsect1>
  59     <refsect1 id="description"><title>Description</title>
  60         <para>
  61             <function>glGetString</function> returns a pointer to a static string
  62             describing some aspect of the current GL connection.
  63             <parameter>name</parameter> can be one of the following:
  64         </para>
  65         <variablelist>
  66             <varlistentry>
  67                 <term><constant>GL_VENDOR</constant></term>
  68                 <listitem>
  69                     <para>
  70                     </para>
  71                     <para>
  72                         Returns the company responsible for this GL implementation.
  73                         This name does not change from release to release.
  74                     </para>
  75                 </listitem>
  76             </varlistentry>
  77             <varlistentry>
  78                 <term><constant>GL_RENDERER</constant></term>
  79                 <listitem>
  80                     <para>
  81                     </para>
  82                     <para>
  83                         Returns the name of the renderer.
  84                         This name is typically specific to a particular configuration of a hardware
  85                         platform.
  86                         It does not change from release to release.
  87                     </para>
  88                 </listitem>
  89             </varlistentry>
  90             <varlistentry>
  91                 <term><constant>GL_VERSION</constant></term>
  92                 <listitem>
  93                     <para>
  94                     </para>
  95                     <para>
  96                         Returns a version or release number.
  97                     </para>
  98                 </listitem>
  99             </varlistentry>
 100             <varlistentry>
 101                 <term><constant>GL_SHADING_LANGUAGE_VERSION</constant></term>
 102                 <listitem>
 103                     <para>
 104                     </para>
 105                     <para>
 106                         Returns a version or release number for the shading language.
 107                     </para>
 108                 </listitem>
 109             </varlistentry>
 110         </variablelist>
 111         <para>
 112             <function>glGetStringi</function> returns a pointer to a static string
 113             indexed by <parameter>index</parameter>.
 114             <parameter>name</parameter> can be one of the following:
 115         </para>
 116         <variablelist>
 117             <varlistentry>
 118                 <term><constant>GL_EXTENSIONS</constant></term>
 119                 <listitem>
 120                     <para>
 121                     </para>
 122                     <para>
 123                         For <function>glGetStringi</function> only, returns the extension string
 124                         supported by the implementation at <parameter>index</parameter>.
 125                     </para>
 126                 </listitem>
 127             </varlistentry>
 128         </variablelist>
 129         <para>
 130             Strings <constant>GL_VENDOR</constant> and <constant>GL_RENDERER</constant> together uniquely specify
 131             a platform. They do not change from release to release and should be used
 132             by platform-recognition algorithms.
 133         </para>
 134         <para>
 135             The <constant>GL_VERSION</constant> and <constant>GL_SHADING_LANGUAGE_VERSION</constant> strings begin with a version number.
 136             The version number uses one
 137             of these forms:
 138         </para>
 139         <para>
 140             <emphasis>major_number.minor_number</emphasis>
 141             <emphasis>major_number.minor_number.release_number</emphasis>
 142         </para>
 143         <para>
 144             Vendor-specific information may follow the version
 145             number. Its format depends on the implementation, but
 146             a space always separates the version number and
 147             the vendor-specific information.
 148         </para>
 149         <para>
 150             All strings are null-terminated.
 151         </para>
 152     </refsect1>
 153     <refsect1 id="notes"><title>Notes</title>
 154         <para>
 155             If an error is generated, <function>glGetString</function> returns 0.
 156         </para>
 157         <para>
 158             The client and server may support different versions.
 159             <function>glGetString</function> always returns a compatible version number.
 160             The release number always describes the server.
 161         </para>
 162     </refsect1>
 163     <refsect1 id="errors"><title>Errors</title>
 164         <para>
 165             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>name</parameter> is not an accepted value.
 166         </para>
 167         <para>
 168             <constant>GL_INVALID_VALUE</constant> is generated by <function>glGetStringi</function> if
 169             <parameter>index</parameter> is outside the valid range for indexed state <parameter>name</parameter>.
 170         </para>
 171     </refsect1>
 172     <refsect1 id="Copyright"><title>Copyright</title>
 173         <para>
 174             Copyright <trademark class="copyright"></trademark> 1991-2006
 175             Silicon Graphics, Inc. Copyright <trademark class="copyright"></trademark> 2010
 176             Khronos Group. This document is licensed under the SGI
 177             Free Software B License. For details, see
 178             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 179         </para>
 180     </refsect1>
 181 </refentry>