forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glFlushMappedBufferRange.xhtml
35 lines (35 loc) · 4.58 KB
/
glFlushMappedBufferRange.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<div class="refentry"><a id="glFlushMappedBufferRange"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glFlushMappedBufferRange — indicate modifications to a range of a mapped buffer</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glFlushMappedBufferRange</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">length</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><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 of the flush operation. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_ARRAY_BUFFER</code>,
<code class="constant">GL_COPY_READ_BUFFER</code>, <code class="constant">GL_COPY_WRITE_BUFFER</code>, <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>,
<code class="constant">GL_PIXEL_PACK_BUFFER</code>, <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>, <code class="constant">GL_TEXTURE_BUFFER</code>,
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>, or <code class="constant">GL_UNIFORM_BUFFER</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
Specifies the start of the buffer subrange, in basic machine units.
</p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
Specifies the length of the buffer subrange, in basic machine units.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glFlushMappedBufferRange</code> indicates that modifications have been made to a range of a mapped buffer.
The buffer must previously have been mapped with the <code class="constant">GL_MAP_FLUSH_EXPLICIT_BIT</code> flag. <em class="parameter"><code>offset</code></em>
and <em class="parameter"><code>length</code></em> indicate the modified subrange of the mapping, in basic units. The specified subrange to flush
is relative to the start of the currently mapped range of the buffer. <code class="function">glFlushMappedBufferRange</code> may be called
multiple times to indicate distinct subranges of the mapping which require flushing.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>offset</code></em> or <em class="parameter"><code>length</code></em>
is negative, or if <em class="parameter"><code>offset</code></em> + <em class="parameter"><code>length</code></em> exceeds the size of the mapping.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if zero is bound to <em class="parameter"><code>target</code></em>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if the buffer bound to <em class="parameter"><code>target</code></em> is not
mapped, or is mapped without the <code class="constant">GL_MAP_FLUSH_EXPLICIT_BIT</code> flag.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glMapBufferRange"><span class="citerefentry"><span class="refentrytitle">glMapBufferRange</span></span></a>,
<a class="citerefentry" href="glMapBuffer"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
<a class="citerefentry" href="glUnmapBuffer"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>
</p></div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2010 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="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p></div></div></div>