Subversion Repositories AndroidProjects

<?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="glGetShaderSource">
    <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 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 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>glGetShader</refentrytitle></citerefentry>
        with the value
        <constant>GL_SHADER_SOURCE_LENGTH</constant>.</para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para><function>glGetShaderSource</function> is available only
        if the GL version is 2.0 or greater.</para>
    </refsect1>
    <refsect1 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>

        <para><constant>GL_INVALID_OPERATION</constant> is generated if
        <function>glGetShaderSource</function> is executed between the
        execution of
        <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
        and the corresponding execution of
        <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.</para>
    </refsect1>
    <refsect1 id="associatedgets"><title>Associated Gets</title>
        <para><citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>
        with argument
        <constant>GL_SHADER_SOURCE_LENGTH</constant></para>

        <para><citerefentry><refentrytitle>glIsShader</refentrytitle></citerefentry></para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para><citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
        <citerefentry><refentrytitle>glShaderSource</refentrytitle></citerefentry></para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
        </para>
    </refsect1>
</refentry>