Opentk/Source/Bind/Specifications/Docs/glDetachShader.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="glDetachShader">
    <refentryinfo>
        <copyright>
            <year>2003-2005</year>
            <holder>3Dlabs Inc. Ltd.</holder>
        </copyright>
        <copyright>
            <year>2010-2013</year>
            <holder>Khronos Group</holder>
        </copyright>
    </refentryinfo>
    <refmeta>
        <refentrytitle>glDetachShader</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glDetachShader</refname>
        <refpurpose>Detaches a shader object from a program object to which it is attached</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
    <funcsynopsis>
        <funcprototype>
        <funcdef>void <function>glDetachShader</function></funcdef>
        <paramdef>GLuint <parameter>program</parameter></paramdef>
        <paramdef>GLuint <parameter>shader</parameter></paramdef>
        </funcprototype>
    </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
    <variablelist>
        <varlistentry>
        <term><parameter>program</parameter></term>
        <listitem>
            <para>Specifies the program object from which to
            detach the shader object.</para>
        </listitem>
        </varlistentry>
        <varlistentry>
        <term><parameter>shader</parameter></term>
        <listitem>
            <para>Specifies the shader object to be
            detached.</para>
        </listitem>
        </varlistentry>
    </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
    <para><function>glDetachShader</function> detaches the shader
    object specified by <parameter>shader</parameter> from the
    program object specified by <parameter>program</parameter>. This
    command can be used to undo the effect of the command
    <citerefentry><refentrytitle>glAttachShader</refentrytitle></citerefentry>.</para>

    <para>If <parameter>shader</parameter> has already been flagged
    for deletion by a call to
    <citerefentry><refentrytitle>glDeleteShader</refentrytitle></citerefentry>
    and it is not attached to any other program object, it will be
    deleted after it has been detached.</para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
    <para><constant>GL_INVALID_VALUE</constant> is generated if either
    <parameter>program</parameter> or <parameter>shader</parameter>
    is a value that was not generated by OpenGL.</para>

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

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

    <para><constant>GL_INVALID_OPERATION</constant> is generated if
    <parameter>shader</parameter> is not attached to
    <parameter>program</parameter>.</para>

    </refsect1>
    <refsect1 id="associatedgets"><title>Associated Gets</title>
    <para><citerefentry><refentrytitle>glGetAttachedShaders</refentrytitle></citerefentry>
    with the handle of a valid program object</para>

    <para><citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>
    with arguments <parameter>shader</parameter> and
    <constant>GL_DELETE_STATUS</constant></para>

    <para><citerefentry><refentrytitle>glIsProgram</refentrytitle></citerefentry></para>

    <para><citerefentry><refentrytitle>glIsShader</refentrytitle></citerefentry></para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
    <para><citerefentry><refentrytitle>glAttachShader</refentrytitle></citerefentry></para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
            Copyright <trademark class="copyright"></trademark> 2010-2013 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.
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
        </para>
    </refsect1>
</refentry>