rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glClearBufferData.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="glClearBufferData">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glClearBufferData</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glClearBufferData</refname>\r
        <refpurpose>fill a buffer object's data store with a fixed value</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glClearBufferData</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLenum <parameter>internalformat</parameter></paramdef>\r
                <paramdef>GLenum <parameter>format</parameter></paramdef>\r
                <paramdef>GLenum <parameter>type</parameter></paramdef>\r
                <paramdef>const void * <parameter>data</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
                    Specify the target of the operation. <parameter>target</parameter> must be\r
                    one of the global buffer binding targets.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>internalformat</parameter></term>\r
            <listitem>\r
                <para>\r
                    The internal format with which the data will be stored in the buffer object.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>size</parameter></term>\r
            <listitem>\r
                <para>\r
                    The size, in basic machine units of the range of the data store to fill.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>format</parameter></term>\r
            <listitem>\r
                <para>\r
                    The format of the data in memory addressed by <parameter>data</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>type</parameter></term>\r
            <listitem>\r
                <para>\r
                    The type of the data in memory addressed by <parameter>data</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>data</parameter></term>\r
            <listitem>\r
                <para>\r
                    The address of a memory location storing the data to be replicated into the\r
                    buffer's data store.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glClearBufferData</function> fills the entirety of a buffer object's\r
            data store with data from client memory. Data, initially supplied in a format\r
            specified by <parameter>format</parameter> in data type <parameter>type</parameter> is\r
            read from the memory address given by <parameter>data</parameter> and converted into\r
            the internal representation given by <parameter>internalforamt</parameter>.\r
            This converted data is then replicated throughout the buffer object's\r
            data store.\r
        </para>\r
        <para>\r
            If <parameter>data</parameter> is NULL, then the buffer's data store\r
            is filled with zeros.\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> not one of the generic buffer binding targets.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if no buffer is bound to <parameter>target</parameter>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a sized internal format.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if any part of the buffer's data store is\r
            mapped with <citerefentry><refentrytitle>glMapBufferRange</refentrytitle></citerefentry> or <citerefentry><refentrytitle>glMapBuffer.</refentrytitle></citerefentry>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glClearBufferSubData</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2011-2012 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