upstream-man-pages/man3/glBufferSubData.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="glBufferSubData">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2005</year>
   9                 <holder>Sams Publishing</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glBufferSubData</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glBufferSubData</refname>
  17         <refpurpose>updates a subset of a buffer object's data store</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glBufferSubData</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLintptr <parameter>offset</parameter></paramdef>
  25                 <paramdef>GLsizeiptr <parameter>size</parameter></paramdef>
  26                 <paramdef>const GLvoid * <parameter>data</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <!-- eqn: ignoring delim $$ -->
  31     <refsect1 id="parameters"><title>Parameters</title>
  32         <variablelist>
  33         <varlistentry>
  34             <term><parameter>target</parameter></term>
  35             <listitem>
  36                 <para>
  37                     Specifies the target buffer object.
  38                     The symbolic constant must be <constant>GL_ARRAY_BUFFER</constant>,
  39                     <constant>GL_COPY_READ_BUFFER</constant>,
  40                     <constant>GL_COPY_WRITE_BUFFER</constant>,
  41                     <constant>GL_ELEMENT_ARRAY_BUFFER</constant>,
  42                     <constant>GL_PIXEL_PACK_BUFFER</constant>,
  43                     <constant>GL_PIXEL_UNPACK_BUFFER</constant>,
  44                     <constant>GL_TEXTURE_BUFFER</constant>,
  45                     <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, or
  46                     <constant>GL_UNIFORM_BUFFER</constant>.
  47                 </para>
  48             </listitem>
  49         </varlistentry>
  50         <varlistentry>
  51             <term><parameter>offset</parameter></term>
  52             <listitem>
  53                 <para>
  54                     Specifies the offset into the buffer object's data store where data replacement will begin,
  55                     measured in bytes.
  56                 </para>
  57             </listitem>
  58         </varlistentry>
  59         <varlistentry>
  60             <term><parameter>size</parameter></term>
  61             <listitem>
  62                 <para>
  63                     Specifies the size in bytes of the data store region being replaced.
  64                 </para>
  65             </listitem>
  66         </varlistentry>
  67         <varlistentry>
  68             <term><parameter>data</parameter></term>
  69             <listitem>
  70                 <para>
  71                     Specifies a pointer to the new data that will be copied into the data store.
  72                 </para>
  73             </listitem>
  74         </varlistentry>
  75         </variablelist>
  76     </refsect1>
  77     <refsect1 id="description"><title>Description</title>
  78         <para>
  79             <function>glBufferSubData</function> redefines some or all of the data store for the buffer object currently
  80             bound to <parameter>target</parameter>. Data starting at byte offset <parameter>offset</parameter> and
  81             extending for <parameter>size</parameter> bytes is copied to the data store from the memory pointed to by
  82             <parameter>data</parameter>.  An error is thrown if <parameter>offset</parameter> and <parameter>size</parameter>
  83             together define a range beyond the bounds of the buffer object's data store.
  84         </para>
  85     </refsect1>
  86     <refsect1 id="notes"><title>Notes</title>
  87         <para>
  88             When replacing the entire data store, consider using <function>glBufferSubData</function> rather
  89             than completely recreating the data store with <function>glBufferData</function>.  This avoids the cost of
  90             reallocating the data store.
  91         </para>
  92         <para>
  93             Consider using multiple buffer objects to avoid stalling the rendering pipeline during data store updates.
  94             If any rendering in the pipeline makes reference to data in the buffer object being updated by
  95             <function>glBufferSubData</function>, especially from the specific region being updated, that rendering must
  96             drain from the pipeline before the data store can be updated.
  97         </para>
  98         <para>
  99             Clients must align data elements consistent with the requirements of the client
 100             platform, with an additional base-level requirement that an offset within a buffer to
 101             a datum comprising <inlineequation><mml:math><mml:mi mathvariant="italic">N</mml:mi> bytes be a
 102             multiple of <mml:mi mathvariant="italic">N</mml:mi></mml:math></inlineequation>.
 103         </para>
 104     </refsect1>
 105     <refsect1 id="errors"><title>Errors</title>
 106         <para>
 107             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not
 108             one of the accepted buffer targets.
 109         </para>
 110         <para>
 111             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>offset</parameter> or
 112             <parameter>size</parameter> is negative, or if together they define a region of memory
 113             that extends beyond the buffer object's allocated data store.
 114         </para>
 115         <para>
 116             <constant>GL_INVALID_OPERATION</constant> is generated if the reserved buffer object name 0 is bound to <parameter>target</parameter>.
 117         </para>
 118         <para>
 119             <constant>GL_INVALID_OPERATION</constant> is generated if the buffer object being updated is mapped.
 120         </para>
 121     </refsect1>
 122     <refsect1 id="associatedgets"><title>Associated Gets</title>
 123         <para>
 124             <citerefentry><refentrytitle>glGetBufferSubData</refentrytitle></citerefentry>
 125         </para>
 126     </refsect1>
 127     <refsect1 id="seealso"><title>See Also</title>
 128         <para>
 129             <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,
 130             <citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>,
 131             <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,
 132             <citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>
 133         </para>
 134     </refsect1>
 135     <refsect1 id="Copyright"><title>Copyright</title>
 136         <para>
 137             Copyright <trademark class="copyright"></trademark> 2005 Addison-Wesley.
 138             This material may be distributed subject to the terms and conditions set forth in
 139             the Open Publication License, v 1.0, 8 June 1999.
 140             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 141         </para>
 142     </refsect1>
 143 </refentry>