rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / xhtml / glFlushMappedBufferRange.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3 <!-- saved from url=(0013)about:internet -->
4 <?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glFlushMappedBufferRange - OpenGL 3.3 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><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 border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glFlushMappedBufferRange</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">length</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>
5 Specifies the target of the flush operation. <em class="parameter"><code>target</code></em> must be <code class="constant">GL_ARRAY_BUFFER</code>,
6 <code class="constant">GL_COPY_READ_BUFFER</code>, <code class="constant">GL_COPY_WRITE_BUFFER</code>, <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>,
7 <code class="constant">GL_PIXEL_PACK_BUFFER</code>, <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>, <code class="constant">GL_TEXTURE_BUFFER</code>,
8 <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>, or <code class="constant">GL_UNIFORM_BUFFER</code>.
9 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
10 Specifies the start of the buffer subrange, in basic machine units.
11 </p></dd><dt><span class="term"><em class="parameter"><code>length</code></em></span></dt><dd><p>
12 Specifies the length of the buffer subrange, in basic machine units.
13 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
14 <code class="function">glFlushMappedBufferRange</code> indicates that modifications have been made to a range of a mapped buffer.
15 The buffer must previously have been mapped with the <code class="constant">GL_MAP_FLUSH_EXPLICIT</code> flag. <em class="parameter"><code>offset</code></em>
16 and <em class="parameter"><code>length</code></em> indicate the modified subrange of the mapping, in basic units. The specified subrange to flush
17 is relative to the start of the currently mapped range of the buffer. <code class="function">glFlushMappedBufferRange</code> may be called
18 multiple times to indicate distinct subranges of the mapping which require flushing.
19 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
20 <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>
21 is negative, or if <em class="parameter"><code>offset</code></em> + <em class="parameter"><code>length</code></em> exceeds the size of the mapping.
22 </p><p>
23 <code class="constant">GL_INVALID_OPERATION</code> is generated if zero is bound to <em class="parameter"><code>target</code></em>.
24 </p><p>
25 <code class="constant">GL_INVALID_OPERATION</code> is generated if the buffer bound to <em class="parameter"><code>target</code></em> is not
26 mapped, or is mapped without the <code class="constant">GL_MAP_FLUSH_EXPLICIT</code> flag.
27 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
28 <a href="glMapBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glMapBufferRange</span></span></a>,
29 <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
30 <a href="glUnmapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>
31 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
32 Copyright <span class="trademark"></span>© 2010 Khronos Group.
33 This material may be distributed subject to the terms and conditions set forth in
34 the Open Publication License, v 1.0, 8 June 1999.
35 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
36 </p></div></div></body></html>