rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glBindFramebuffer.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="glBindFramebuffer">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glBindFramebuffer</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glBindFramebuffer</refname>\r
        <refpurpose>bind a framebuffer to a framebuffer target</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glBindFramebuffer</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLuint <parameter>framebuffer</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>target</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the framebuffer target of the binding operation.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>framebuffer</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the name of the framebuffer object to bind.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glBindFramebuffer</function> binds the framebuffer object with name <parameter>framebuffer</parameter> to the framebuffer target specified\r
            by <parameter>target</parameter>. <parameter>target</parameter> must be either <constant>GL_DRAW_FRAMEBUFFER</constant>,\r
            <constant>GL_READ_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>. If a framebuffer object is bound to\r
            <constant>GL_DRAW_FRAMEBUFFER</constant> or <constant>GL_READ_FRAMEBUFFER</constant>, it becomes the target for\r
            rendering or readback operations, respectively, until it is deleted or another framebuffer is bound to the corresponding bind point.\r
            Calling <function>glBindFramebuffer</function> with <parameter>target</parameter> set to <constant>GL_FRAMEBUFFER</constant> binds\r
            <parameter>framebuffer</parameter> to both the read and draw framebuffer targets. <parameter>framebuffer</parameter> is the name of a framebuffer\r
            object previously returned from a call to <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>, or zero to break the existing\r
            binding of a framebuffer object to <parameter>target</parameter>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_DRAW_FRAMEBUFFER</constant>,\r
            <constant>GL_READ_FRAMEBUFFER</constant> or <constant>GL_FRAMEBUFFER</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>framebuffer</parameter> is not zero or the name of a framebuffer\r
            previously returned from a call to <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture1D</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture2D</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture3D</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTextureFace</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTextureLayer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glIsFramebuffer</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.\r
            This material may be distributed subject to the terms and conditions set forth in\r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r