Opentk/Source/Bind/Specifications/Docs/ES20/glGenFramebuffers.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="glGenFramebuffers">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>2005</year>
                <holder>Sams Publishing</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glGenFramebuffers</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glGenFramebuffers</refname>
        <refpurpose>generate framebuffer object names</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glGenFramebuffers</function></funcdef>
                <paramdef>GLsizei <parameter>n</parameter></paramdef>
                <paramdef>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 object names to be generated.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>framebuffers</parameter></term>
            <listitem>
                <para>
                    Specifies an array in which the generated framebuffer object names are stored.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glGenFramebuffers</function> returns <parameter>n</parameter> framebuffer object names in <parameter>framebuffers</parameter>.
            There is no guarantee that the names form a contiguous set of integers;
            however, it is guaranteed that none of the returned names was in use
            immediately before the call to <function>glGenFramebuffers</function>.
        </para>
        <para>
            Framebuffer object names returned by a call to <function>glGenFramebuffers</function> are not returned by
            subsequent calls, unless they are first deleted with
            <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry>.
        </para>
        <para>
            No framebuffer objects are associated with the returned framebuffer object names until they are first bound by calling
            <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>.
        </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>glDeleteFramebuffers</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>