Opentk/Source/Bind/Specifications/Docs/ES20/glDeleteFramebuffers.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="glDeleteFramebuffers">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>2005</year>
                <holder>Sams Publishing</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glDeleteFramebuffers</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glDeleteFramebuffers</refname>
        <refpurpose>delete named framebuffer objects</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glDeleteFramebuffers</function></funcdef>
                <paramdef>GLsizei <parameter>n</parameter></paramdef>
                <paramdef>const GLuint * <parameter>framebuffers</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>n</parameter></term>
            <listitem>
                <para>
                    Specifies the number of framebuffer objects to be deleted.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>framebuffers</parameter></term>
            <listitem>
                <para>
                    Specifies an array of framebuffer objects to be deleted.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glDeleteFramebuffers</function> deletes <parameter>n</parameter> framebuffer objects named by the elements of the array <parameter>framebuffers</parameter>.
            After a framebuffer object is deleted, it has no attachments,
            and its name is free for reuse (for example by <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>).
            If a framebuffer object that is currently bound is deleted, the binding reverts
            to 0 (the window-system-provided framebuffer).
        </para>
        <para>
            <function>glDeleteFramebuffers</function> silently ignores 0's and names that do not correspond to
            existing framebuffer objects.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
        </para>
    </refsect1>
    <refsect1 id="associatedgets"><title>Associated Gets</title>
        <para>
            <citerefentry><refentrytitle>glIsFramebuffer</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glIsFramebuffer</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2008 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>