rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glFlushMappedBufferRange.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="glFlushMappedBufferRange">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glFlushMappedBufferRange</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glFlushMappedBufferRange</refname>\r
        <refpurpose>indicate modifications to a range of a mapped buffer</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glFlushMappedBufferRange</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLintptr <parameter>offset</parameter></paramdef>\r
                <paramdef>GLsizeiptr <parameter>length</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <!-- eqn: ignoring delim $$ -->\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>target</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the target of the flush operation. <parameter>target</parameter> must be <constant>GL_ARRAY_BUFFER</constant>,\r
                    <constant>GL_COPY_READ_BUFFER</constant>, <constant>GL_COPY_WRITE_BUFFER</constant>, <constant>GL_ELEMENT_ARRAY_BUFFER</constant>,\r
                    <constant>GL_PIXEL_PACK_BUFFER</constant>, <constant>GL_PIXEL_UNPACK_BUFFER</constant>, <constant>GL_TEXTURE_BUFFER</constant>,\r
                    <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, or <constant>GL_UNIFORM_BUFFER</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>offset</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the start of the buffer subrange, in basic machine units.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>length</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the length of the buffer subrange, in basic machine units.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glFlushMappedBufferRange</function> indicates that modifications have been made to a range of a mapped buffer.\r
            The buffer must previously have been mapped with the <constant>GL_MAP_FLUSH_EXPLICIT</constant> flag. <parameter>offset</parameter>\r
            and <parameter>length</parameter> indicate the modified subrange of the mapping, in basic units. The specified subrange to flush\r
            is relative to the start of the currently mapped range of the buffer. <function>glFlushMappedBufferRange</function> may be called\r
            multiple times to indicate distinct subranges of the mapping which require flushing.\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 <parameter>length</parameter>\r
            is negative, or if <parameter>offset</parameter> + <parameter>length</parameter> exceeds the size of the mapping.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>target</parameter>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if the buffer bound to <parameter>target</parameter> is not\r
            mapped, or is mapped without the <constant>GL_MAP_FLUSH_EXPLICIT</constant> flag.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glMapBufferRange</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glUnmapBuffer</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