upstream-man-pages/man3/glFlushMappedBufferRange.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glFlushMappedBufferRange">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glFlushMappedBufferRange</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glFlushMappedBufferRange</refname>
  17         <refpurpose>indicate modifications to a range of a mapped buffer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glFlushMappedBufferRange</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLintptr <parameter>offset</parameter></paramdef>
  25                 <paramdef>GLsizeiptr <parameter>length</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28     </refsynopsisdiv>
  29     <!-- eqn: ignoring delim $$ -->
  30     <refsect1 id="parameters"><title>Parameters</title>
  31         <variablelist>
  32         <varlistentry>
  33             <term><parameter>target</parameter></term>
  34             <listitem>
  35                 <para>
  36                     Specifies the target of the flush operation. <parameter>target</parameter> must be <constant>GL_ARRAY_BUFFER</constant>,
  37                     <constant>GL_COPY_READ_BUFFER</constant>, <constant>GL_COPY_WRITE_BUFFER</constant>, <constant>GL_ELEMENT_ARRAY_BUFFER</constant>,
  38                     <constant>GL_PIXEL_PACK_BUFFER</constant>, <constant>GL_PIXEL_UNPACK_BUFFER</constant>, <constant>GL_TEXTURE_BUFFER</constant>,
  39                     <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, or <constant>GL_UNIFORM_BUFFER</constant>.
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         <varlistentry>
  44             <term><parameter>offset</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specifies the start of the buffer subrange, in basic machine units.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         <varlistentry>
  52             <term><parameter>length</parameter></term>
  53             <listitem>
  54                 <para>
  55                     Specifies the length of the buffer subrange, in basic machine units.
  56                 </para>
  57             </listitem>
  58         </varlistentry>
  59         </variablelist>
  60     </refsect1>
  61     <refsect1 id="description"><title>Description</title>
  62         <para>
  63             <function>glFlushMappedBufferRange</function> indicates that modifications have been made to a range of a mapped buffer.
  64             The buffer must previously have been mapped with the <constant>GL_MAP_FLUSH_EXPLICIT</constant> flag. <parameter>offset</parameter>
  65             and <parameter>length</parameter> indicate the modified subrange of the mapping, in basic units. The specified subrange to flush
  66             is relative to the start of the currently mapped range of the buffer. <function>glFlushMappedBufferRange</function> may be called
  67             multiple times to indicate distinct subranges of the mapping which require flushing.
  68         </para>
  69     </refsect1>
  70     <refsect1 id="errors"><title>Errors</title>
  71         <para>
  72             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>offset</parameter> or <parameter>length</parameter>
  73             is negative, or if <parameter>offset</parameter> + <parameter>length</parameter> exceeds the size of the mapping.
  74         </para>
  75         <para>
  76             <constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>target</parameter>.
  77         </para>
  78         <para>
  79             <constant>GL_INVALID_OPERATION</constant> is generated if the buffer bound to <parameter>target</parameter> is not
  80             mapped, or is mapped without the <constant>GL_MAP_FLUSH_EXPLICIT</constant> flag.
  81         </para>
  82     </refsect1>
  83     <refsect1 id="seealso"><title>See Also</title>
  84         <para>
  85             <citerefentry><refentrytitle>glMapBufferRange</refentrytitle></citerefentry>,
  86             <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,
  87             <citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>
  88         </para>
  89     </refsect1>
  90     <refsect1 id="Copyright"><title>Copyright</title>
  91         <para>
  92             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  93             This material may be distributed subject to the terms and conditions set forth in
  94             the Open Publication License, v 1.0, 8 June 1999.
  95             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  96         </para>
  97     </refsect1>
  98 </refentry>