Opentk/Source/Bind/Specifications/Docs/GL/glIsFramebuffer.xml

<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glIsFramebuffer">
    <info>
        <copyright>
            <year>2010-2013</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>glIsFramebuffer</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glIsFramebuffer</refname>
        <refpurpose>determine if a name corresponds to a framebuffer object</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>GLboolean <function>glIsFramebuffer</function></funcdef>
                <paramdef>GLuint <parameter>framebuffer</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>framebuffer</parameter></term>
            <listitem>
                <para>
                    Specifies a value that may be the name of a framebuffer object.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>glIsFramebuffer</function> returns <constant>GL_TRUE</constant> if <parameter>framebuffer</parameter> is currently the name of a framebuffer
            object. If <parameter>framebuffer</parameter> is zero, or if <constant>framebuffer</constant> is not the name of a framebuffer object, or if an error
            occurs, <function>glIsFramebuffer</function> returns <constant>GL_FALSE</constant>. If <parameter>framebuffer</parameter> is a name returned by
            <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>, by that has not yet been bound through a call to
            <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>, then the name is not a framebuffer object and <function>glIsFramebuffer</function>
            returns <constant>GL_FALSE</constant>.
        </para>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 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.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>