Opentk/Source/Bind/Specifications/Docs/glGetString.xml

<?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="glGetString">
    <refentryinfo>
        <copyright>
            <year>1991-2006</year>
            <holder>Silicon Graphics, Inc.</holder>
        </copyright>
        <copyright>
            <year>2010-2013</year>
            <holder>Khronos Group</holder>
        </copyright>
    </refentryinfo>
    <refmeta>
        <refentrytitle>glGetString</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glGetString</refname>
        <refpurpose>return a string describing the current GL connection</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>const GLubyte* <function>glGetString</function></funcdef>
                <paramdef>GLenum <parameter>name</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
        <funcsynopsis>
            <funcprototype>
                <funcdef>const GLubyte* <function>glGetStringi</function></funcdef>
                <paramdef>GLenum <parameter>name</parameter></paramdef>
                <paramdef>GLuint <parameter>index</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>GL_VENDOR</constant>, <constant>GL_RENDERER</constant>,
                    <constant>GL_VERSION</constant>, or <constant>GL_SHADING_LANGUAGE_VERSION</constant>.
                    Additionally, <function>glGetStringi</function> accepts the <constant>GL_EXTENSIONS</constant> token.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>index</parameter></term>
            <listitem>
                <para>
                    For <function>glGetStringi</function>, specifies the index of the string to return.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glGetString</function> returns a pointer to a static string
            describing some aspect of the current GL connection.
            <parameter>name</parameter> can be one of the following:
        </para>
        <variablelist>
            <varlistentry>
                <term><constant>GL_VENDOR</constant></term>
                <listitem>
                    <para>
                        Returns the company responsible for this GL implementation.
                        This name does not change from release to release.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_RENDERER</constant></term>
                <listitem>
                    <para>
                        Returns the name of the renderer.
                        This name is typically specific to a particular configuration of a hardware
                        platform.
                        It does not change from release to release.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_VERSION</constant></term>
                <listitem>
                    <para>
                        Returns a version or release number.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><constant>GL_SHADING_LANGUAGE_VERSION</constant></term>
                <listitem>
                    <para>
                        Returns a version or release number for the shading language.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
        <para>
            <function>glGetStringi</function> returns a pointer to a static string
            indexed by <parameter>index</parameter>.
            <parameter>name</parameter> can be one of the following:
        </para>
        <variablelist>
            <varlistentry>
                <term><constant>GL_EXTENSIONS</constant></term>
                <listitem>
                    <para>
                        For <function>glGetStringi</function> only, returns the extension string
                        supported by the implementation at <parameter>index</parameter>.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
        <para>
            Strings <constant>GL_VENDOR</constant> and <constant>GL_RENDERER</constant> together uniquely specify
            a platform. They do not change from release to release and should be used
            by platform-recognition algorithms.
        </para>
        <para>
            The <constant>GL_VERSION</constant> and <constant>GL_SHADING_LANGUAGE_VERSION</constant> strings begin with a version number.
            The version number uses one
            of these forms:
        </para>
        <para>
            <emphasis>major_number.minor_number</emphasis>
            <emphasis>major_number.minor_number.release_number</emphasis>
        </para>
        <para>
            Vendor-specific information may follow the version
            number. Its format depends on the implementation, but
            a space always separates the version number and
            the vendor-specific information.
        </para>
        <para>
            All strings are null-terminated.
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            If an error is generated, <function>glGetString</function> returns 0.
        </para>
        <para>
            The client and server may support different versions.
            <function>glGetString</function> always returns a compatible version number.
            The release number always describes the server.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>name</parameter> is not an accepted value.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated by <function>glGetStringi</function> if
            <parameter>index</parameter> is outside the valid range for indexed state <parameter>name</parameter>.
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 1991-2006 Silicon Graphics, Inc.
            Copyright <trademark class="copyright"></trademark> 2010-2013 Khronos Group.
            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>