<div class="refentry" id="glBufferSubData">

<div class="titlepage"></div>

<div class="refnamediv">

<h2>Name</h2>

<p>glBufferSubData, glNamedBufferSubData — updates a subset of a buffer object's data store</p>

</div>

<div class="refsynopsisdiv">

<h2>C Specification</h2>

<div class="funcsynopsis">

<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">

<tr>

<td>

<code class="funcdef">void <strong class="fsfunc">glBufferSubData</strong>(</code>

</td>

<td>GLenum <var class="pdparam">target</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLintptr <var class="pdparam">offset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLsizeiptr <var class="pdparam">size</var>, </td>

</tr>

<tr>

<td> </td>

<td>const GLvoid * <var class="pdparam">data</var><code>)</code>;</td>

</tr>

</table>

<div class="funcprototype-spacer"> </div>

<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">

<tr>

<td>

<code class="funcdef">void <strong class="fsfunc">glNamedBufferSubData</strong>(</code>

</td>

<td>GLuint <var class="pdparam">buffer</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLintptr <var class="pdparam">offset</var>, </td>

</tr>

<tr>

<td> </td>

<td>GLsizei <var class="pdparam">size</var>, </td>

</tr>

<tr>

<td> </td>

<td>const void *<var class="pdparam">data</var><code>)</code>;</td>

</tr>

</table>

<div class="funcprototype-spacer"> </div>

</div>

</div>

<div class="refsect1" id="parameters">

<h2>Parameters</h2>

<div class="variablelist">

<dl class="variablelist">

<dt>

<span class="term">

<em class="parameter">

<code>target</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies the target to which the buffer object is bound

for <code class="function">glBufferSubData</code>, which must be

one of the buffer binding targets in the following

table:

</p>

<div class="informaltable">

<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">

<colgroup>

<col style="text-align: left; " class="col1"/>

<col style="text-align: left; " class="col2"/>

</colgroup>

<thead>

<tr>

<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold">

<strong>Buffer Binding Target</strong>

</span>

</th>

<th style="text-align: left; border-bottom: 2px solid ; ">

<span class="bold">

<strong>Purpose</strong>

</span>

</th>

</tr>

</thead>

<tbody>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_ARRAY_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Vertex attributes</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Atomic counter storage</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_COPY_READ_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Buffer copy source</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_COPY_WRITE_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Buffer copy destination</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_DISPATCH_INDIRECT_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Indirect compute dispatch commands</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_DRAW_INDIRECT_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Indirect command arguments</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Vertex array indices</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_PIXEL_PACK_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Pixel read target</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_PIXEL_UNPACK_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Texture data source</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_QUERY_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Query result buffer</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_SHADER_STORAGE_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Read-write storage for shaders</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_TEXTURE_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Texture data buffer</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>

</td>

<td style="text-align: left; border-bottom: 2px solid ; ">Transform feedback buffer</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; ">

<code class="constant">GL_UNIFORM_BUFFER</code>

</td>

<td style="text-align: left; ">Uniform block storage</td>

</tr>

</tbody>

</table>

</div>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>buffer</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies the name of the buffer object

for <code class="function">glNamedBufferSubData</code>.

</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>offset</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies the offset into the buffer object's data store

where data replacement will begin, measured in bytes.

</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>size</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies the size in bytes of the data store region

being replaced.

</p>

</dd>

<dt>

<span class="term">

<em class="parameter">

<code>data</code>

</em>

</span>

</dt>

<dd>

<p>

Specifies a pointer to the new data that will be copied

into the data store.

</p>

</dd>

</dl>

</div>

</div>

<div class="refsect1" id="description">

<h2>Description</h2>

<p>

<code class="function">glBufferSubData</code> and

<code class="function">glNamedBufferSubData</code> redefine some or all

of the data store for the specified buffer object. Data starting

at byte offset <em class="parameter"><code>offset</code></em> and extending for

<em class="parameter"><code>size</code></em> bytes is copied to the data store

from the memory pointed to by <em class="parameter"><code>data</code></em>.

<em class="parameter"><code>offset</code></em> and <em class="parameter"><code>size</code></em>

must define a range lying entirely within the buffer object's

data store.

</p>

</div>

<div class="refsect1" id="notes">

<h2>Notes</h2>

<p>

When replacing the entire data store, consider using

<code class="function">glBufferSubData</code> rather than completely

recreating the data store with

<code class="function">glBufferData</code>. This avoids the cost of

reallocating the data store.

</p>

<p>

Consider using multiple buffer objects to avoid stalling the

rendering pipeline during data store updates. If any rendering

in the pipeline makes reference to data in the buffer object

being updated by <code class="function">glBufferSubData</code>,

especially from the specific region being updated, that

rendering must drain from the pipeline before the data store can

be updated.

</p>

<p>

Clients must align data elements consistent with the

requirements of the client platform, with an additional

base-level requirement that an offset within a buffer to a datum

comprising <math overflow="scroll"><mi mathvariant="italic">N</mi></math> bytes be a

multiple of <math overflow="scroll"><mi mathvariant="italic">N</mi></math>.

</p>

<p>

The <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code> target is

available only if the GL version is 4.2 or greater.

</p>

<p>

The <code class="constant">GL_DISPATCH_INDIRECT_BUFFER</code> and

<code class="constant">GL_SHADER_STORAGE_BUFFER</code> targets are

available only if the GL version is 4.3 or greater.

</p>

<p>

The <code class="constant">GL_QUERY_BUFFER</code> target is available

only if the GL version is 4.4 or greater.

</p>

</div>

<div class="refsect1" id="errors">

<h2>Errors</h2>

<p>

<code class="constant">GL_INVALID_ENUM</code> is generated by

<code class="function">glBufferSubData</code> if

<em class="parameter"><code>target</code></em> is not one of the accepted buffer

targets.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated by

<code class="function">glBufferSubData</code> if zero is bound to

<em class="parameter"><code>target</code></em>.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated by

<code class="function">glNamedBufferSubData</code> if

<em class="parameter"><code>buffer</code></em> is not the name of an existing

buffer object.

</p>

<p>

<code class="constant">GL_INVALID_VALUE</code> is generated if

<em class="parameter"><code>offset</code></em> or <em class="parameter"><code>size</code></em> is

negative, or if $offset + size$ is greater than the value of

<code class="constant">GL_BUFFER_SIZE</code> for the specified buffer

object.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated if any

part of the specified range of the buffer object is mapped with

<a class="citerefentry" href="glMapBufferRange"><span class="citerefentry"><span class="refentrytitle">glMapBufferRange</span></span></a>

or

<a class="citerefentry" href="glMapBuffer"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,

unless it was mapped with the

<code class="constant">GL_MAP_PERSISTENT_BIT</code> bit set in the

<code class="function">glMapBufferRange</code>

<em class="parameter"><code>access</code></em> flags.

</p>

<p>

<code class="constant">GL_INVALID_OPERATION</code> is generated if the

value of the <code class="constant">GL_BUFFER_IMMUTABLE_STORAGE</code>

flag of the buffer object is <code class="constant">GL_TRUE</code> and

the value of <code class="constant">GL_BUFFER_STORAGE_FLAGS</code> for

the buffer object does not have the

<code class="constant">GL_DYNAMIC_STORAGE_BIT</code> bit set.

</p>

</div>

<div class="refsect1" id="associatedgets">

<h2>Associated Gets</h2>

<p>

<a class="citerefentry" href="glGetBufferSubData"><span class="citerefentry"><span class="refentrytitle">glGetBufferSubData</span></span></a>

</p>

</div>

{$pipelinestall}{$examples}

<div class="refsect1" id="versions">

<h2>Version Support</h2>

<div class="informaltable">

<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">

<colgroup>

<col style="text-align: left; "/>

<col style="text-align: center; " class="firstvers"/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; " class="lastvers"/>

</colgroup>

<thead>

<tr>

<th style="text-align: left; border-right: 2px solid ; ">

</th>

<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">

<span class="bold"><strong>OpenGL Version</strong></span>

</th>

</tr>

<tr>

<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>Function / Feature Name</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>2.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>2.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.2</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.3</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.0</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.1</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.2</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.3</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.4</strong></span>

</th>

<th style="text-align: center; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.5</strong></span>

</th>

</tr>

</thead>

<tbody>

<tr>

<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<code class="function">glBufferSubData</code>

</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>

<td style="text-align: center; border-bottom: 2px solid ; ">✔</td>

</tr>

<tr>

<td style="text-align: left; border-right: 2px solid ; ">

<code class="function">glNamedBufferSubData</code>

</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; ">✔</td>

</tr>

</tbody>

</table>

</div>

</div>

<div class="refsect1" id="seealso">

<h2>See Also</h2>

<p>

<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,

<a class="citerefentry" href="glBufferData"><span class="citerefentry"><span class="refentrytitle">glBufferData</span></span></a>,

<a class="citerefentry" href="glMapBuffer"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,

<a class="citerefentry" href="glMapBufferRange"><span class="citerefentry"><span class="refentrytitle">glMapBufferRange</span></span></a>,

<a class="citerefentry" href="glUnmapBuffer"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>

</p>

</div>

<div class="refsect1" id="Copyright">

<h2>Copyright</h2>

<p>

Copyright © 2005 Addison-Wesley.

Copyright © 2010-2014 Khronos Group.

This material may be distributed subject to the terms and conditions set forth in

the Open Publication License, v 1.0, 8 June 1999.

<a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.

</p>

</div>

</div>