rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glInvalidateBufferSubData.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="glInvalidateBufferSubData">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glInvalidateBufferSubData</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glInvalidateBufferSubData</refname>\r
        <refpurpose>invalidate a region of a buffer object's data store</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glInvalidateBufferSubData</function></funcdef>\r
                <paramdef>GLuint <parameter>buffer</parameter></paramdef>\r
                <paramdef>GLintptr <parameter>offset</parameter></paramdef>\r
                <paramdef>GLsizeiptr <parameter>length</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>buffer</parameter></term>\r
            <listitem>\r
                <para>\r
                    The name of a buffer object, a subrange of whose data store to invalidate.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>offset</parameter></term>\r
            <listitem>\r
                <para>\r
                    The offset within the buffer's data store of the start of the range to be invalidated.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>length</parameter></term>\r
            <listitem>\r
                <para>\r
                    The length of the range within the buffer's data store to be invalidated.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glInvalidateBufferSubData</function> invalidates all or part of the\r
            content of the data store of a buffer object. After invalidation, the content\r
            of the specified range of the buffer's data store becomes undefined. The\r
            start of the range is given by <parameter>offset</parameter> and its size\r
            is given by <parameter>length</parameter>, both measured in basic machine units.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>offset</parameter> or\r
            <parameter>length</parameter> is negative, or if <parameter>offset</parameter> +\r
            <parameter>length</parameter> is greater than the value of <constant>GL_BUFFER_SIZE</constant>\r
            for <parameter>buffer</parameter>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> is not the\r
            name of an existing buffer object.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if any part of <parameter>buffer</parameter>\r
            is currently mapped.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGetBufferParameter</refentrytitle></citerefentry> with argument <constant>GL_BUFFER_SIZE</constant>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,,\r
            <citerefentry><refentrytitle>glInvalidateTexImage</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 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