Opentk/Source/Bind/Specifications/Docs/ES31/glGetShaderSource.xml

<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glGetShaderSource">
    <info>
        <copyright>
            <year>2003-2005</year>
            <holder>3Dlabs Inc. Ltd.</holder>
        </copyright>
        <copyright>
            <year>2010-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>glGetShaderSource</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glGetShaderSource</refname>
        <refpurpose>Returns the source code string from a shader object</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>C Specification</title>
    <funcsynopsis>
        <funcprototype>
        <funcdef>void <function>glGetShaderSource</function></funcdef>
        <paramdef>GLuint <parameter>shader</parameter></paramdef>
        <paramdef>GLsizei <parameter>bufSize</parameter></paramdef>
        <paramdef>GLsizei *<parameter>length</parameter></paramdef>
        <paramdef>GLchar *<parameter>source</parameter></paramdef>
        </funcprototype>
    </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
    <variablelist>
        <varlistentry>
        <term><parameter>shader</parameter></term>
        <listitem>
            <para>Specifies the shader object to be
            queried.</para>
        </listitem>
        </varlistentry>
        <varlistentry>
        <term><parameter>bufSize</parameter></term>
        <listitem>
            <para>Specifies the size of the character buffer for
            storing the returned source code string.</para>
        </listitem>
        </varlistentry>
        <varlistentry>
        <term><parameter>length</parameter></term>
        <listitem>
            <para>Returns the length of the string returned in
            <parameter>source</parameter> (excluding the null
            terminator).</para>
        </listitem>
        </varlistentry>
        <varlistentry>
        <term><parameter>source</parameter></term>
        <listitem>
            <para>Specifies an array of characters that is used
            to return the source code string.</para>
        </listitem>
        </varlistentry>
    </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
    <para><function>glGetShaderSource</function> returns the
    concatenation of the source code strings from the shader object
    specified by <parameter>shader</parameter>. The source code
    strings for a shader object are the result of a previous call to
    <citerefentry><refentrytitle>glShaderSource</refentrytitle></citerefentry>.
    The string returned by the function will be null
    terminated.</para>

    <para><function>glGetShaderSource</function> returns in
    <parameter>source</parameter> as much of the source code string
    as it can, up to a maximum of <parameter>bufSize</parameter>
    characters. The number of characters actually returned,
    excluding the null termination character, is specified by
    <parameter>length</parameter>. If the length of the returned
    string is not required, a value of <constant>NULL</constant> can
    be passed in the <parameter>length</parameter> argument. The
    size of the buffer required to store the returned source code
    string can be obtained by calling
    <citerefentry><refentrytitle>glGetShaderiv</refentrytitle></citerefentry>
    with the value
    <constant>GL_SHADER_SOURCE_LENGTH</constant>.</para>
    </refsect1>
    <refsect1 xml:id="errors"><title>Errors</title>
    <para><constant>GL_INVALID_VALUE</constant> is generated if
    <parameter>shader</parameter> is not a value generated by
    OpenGL.</para>

    <para><constant>GL_INVALID_OPERATION</constant> is generated if
    <parameter>shader</parameter> is not a shader object.</para>

    <para><constant>GL_INVALID_VALUE</constant> is generated if
    <parameter>bufSize</parameter> is less than 0.</para>

    </refsect1>
    <refsect1 xml:id="associatedgets"><title>Associated Gets</title>
    <para><citerefentry><refentrytitle>glGetShaderiv</refentrytitle></citerefentry>
    with argument
    <constant>GL_SHADER_SOURCE_LENGTH</constant></para>

    <para><citerefentry><refentrytitle>glIsShader</refentrytitle></citerefentry></para>
    </refsect1>
    <refsect1 xml:id="versions">
        <title>API Version Support</title>
        <informaltable>
            <tgroup cols="4" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>glGetShaderSource</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='es20']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
    <para><citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
    <citerefentry><refentrytitle>glShaderSource</refentrytitle></citerefentry></para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2003-2005 3Dlabs Inc. Ltd.
            Copyright <trademark class="copyright"/> 2010-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>