upstream-man-pages/man2/xhtml/glBufferSubData.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glBufferSubData</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glBufferSubData"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBufferSubData — updates a subset of a buffer object's data store</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glBufferSubData</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLintptr  </td><td><var class="pdparam">offset</var>, </td></tr><tr><td> </td><td>GLsizeiptr  </td><td><var class="pdparam">size</var>, </td></tr><tr><td> </td><td>const GLvoid *  </td><td><var class="pdparam">data</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
   4                     Specifies the target buffer object.
   5                     The symbolic constant must be <code class="constant">GL_ARRAY_BUFFER</code>,
   6                     <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>,
   7                     <code class="constant">GL_PIXEL_PACK_BUFFER</code>, or
   8                     <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>.
   9                 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
  10                     Specifies the offset into the buffer object's data store where data replacement will begin,
  11                     measured in bytes.
  12                 </p></dd><dt><span class="term"><em class="parameter"><code>size</code></em></span></dt><dd><p>
  13                     Specifies the size in bytes of the data store region being replaced.
  14                 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
  15                     Specifies a pointer to the new data that will be copied into the data store.
  16                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  17             <code class="function">glBufferSubData</code> redefines some or all of the data store for the buffer object currently
  18             bound to <em class="parameter"><code>target</code></em>. Data starting at byte offset <em class="parameter"><code>offset</code></em> and
  19             extending for <em class="parameter"><code>size</code></em> bytes is copied to the data store from the memory pointed to by
  20             <em class="parameter"><code>data</code></em>.  An error is thrown if <em class="parameter"><code>offset</code></em> and <em class="parameter"><code>size</code></em>
  21             together define a range beyond the bounds of the buffer object's data store.
  22         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  23             <code class="function">glBufferSubData</code> is available only if the GL version is 1.5 or greater.
  24         </p><p>
  25             Targets <code class="constant">GL_PIXEL_PACK_BUFFER</code> and <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> are available
  26             only if the GL version is 2.1 or greater.
  27         </p><p>
  28             When replacing the entire data store, consider using <code class="function">glBufferSubData</code> rather
  29             than completely recreating the data store with <code class="function">glBufferData</code>.  This avoids the cost of
  30             reallocating the data store.
  31         </p><p>
  32             Consider using multiple buffer objects to avoid stalling the rendering pipeline during data store updates.
  33             If any rendering in the pipeline makes reference to data in the buffer object being updated by
  34             <code class="function">glBufferSubData</code>, especially from the specific region being updated, that rendering must
  35             drain from the pipeline before the data store can be updated.
  36         </p><p>
  37             Clients must align data elements consistent with the requirements of the client
  38             platform, with an additional base-level requirement that an offset within a buffer to
  39             a datum comprising <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">N</mml:mi> bytes be a
  40             multiple of <mml:mi mathvariant="italic">N</mml:mi></mml:math>.
  41         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  42             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not
  43             <code class="constant">GL_ARRAY_BUFFER</code>, <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>,
  44             <code class="constant">GL_PIXEL_PACK_BUFFER</code>, or <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>.
  45         </p><p>
  46             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>offset</code></em> or
  47             <em class="parameter"><code>size</code></em> is negative, or if together they define a region of memory
  48             that extends beyond the buffer object's allocated data store.
  49         </p><p>
  50             <code class="constant">GL_INVALID_OPERATION</code> is generated if the reserved buffer object name 0 is bound to <em class="parameter"><code>target</code></em>.
  51         </p><p>
  52             <code class="constant">GL_INVALID_OPERATION</code> is generated if the buffer object being updated is mapped.
  53         </p><p>
  54             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glBufferSubData</code>
  55             is executed between the execution of
  56             <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of
  57             <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  58         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  59             <a class="citerefentry" href="glGetBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glGetBufferSubData</span></span></a>
  60         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  61             <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
  62             <a class="citerefentry" href="glBufferData.xml"><span class="citerefentry"><span class="refentrytitle">glBufferData</span></span></a>,
  63             <a class="citerefentry" href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
  64             <a class="citerefentry" href="glUnmapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>
  65         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  66             Copyright <span class="trademark"></span>© 2005 Addison-Wesley.
  67             This material may be distributed subject to the terms and conditions set forth in
  68             the Open Publication License, v 1.0, 8 June 1999.
  69             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  70         </p></div></div></body></html>