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>glGetBufferSubData
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.69.1" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glGetBufferSubData"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glGetBufferSubData — returns 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">glGetBufferSubData
</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>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>
5 Specifies the target buffer object.
6 The symbolic constant must be
<code class=
"constant">GL_ARRAY_BUFFER
</code>,
7 <code class=
"constant">GL_COPY_READ_BUFFER
</code>,
8 <code class=
"constant">GL_COPY_WRITE_BUFFER
</code>,
9 <code class=
"constant">GL_ELEMENT_ARRAY_BUFFER
</code>,
10 <code class=
"constant">GL_PIXEL_PACK_BUFFER
</code>,
11 <code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code>,
12 <code class=
"constant">GL_TEXTURE_BUFFER
</code>,
13 <code class=
"constant">GL_TRANSFORM_FEEDBACK_BUFFER
</code>, or
14 <code class=
"constant">GL_UNIFORM_BUFFER
</code>.
15 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>offset
</code></em></span></dt><dd><p>
16 Specifies the offset into the buffer object's data store from which data will be returned,
18 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>size
</code></em></span></dt><dd><p>
19 Specifies the size in bytes of the data store region being returned.
20 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>data
</code></em></span></dt><dd><p>
21 Specifies a pointer to the location where buffer object data is returned.
22 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
23 <code class=
"function">glGetBufferSubData
</code> returns some or all of the data from the buffer object currently
24 bound to
<em class=
"parameter"><code>target
</code></em>. Data starting at byte offset
<em class=
"parameter"><code>offset
</code></em> and
25 extending for
<em class=
"parameter"><code>size
</code></em> bytes is copied from the data store to the memory pointed to by
26 <em class=
"parameter"><code>data
</code></em>. An error is thrown if the buffer object is currently mapped, or if
27 <em class=
"parameter"><code>offset
</code></em> and
<em class=
"parameter"><code>size
</code></em> together define a range beyond the bounds
28 of the buffer object's data store.
29 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"notes"></a><h2>Notes
</h2><p>
30 If an error is generated,
31 no change is made to the contents of
<em class=
"parameter"><code>data
</code></em>.
32 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
33 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>target
</code></em> is not
34 <code class=
"constant">GL_ARRAY_BUFFER
</code>,
<code class=
"constant">GL_ELEMENT_ARRAY_BUFFER
</code>,
35 <code class=
"constant">GL_PIXEL_PACK_BUFFER
</code>, or
<code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code>.
37 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>offset
</code></em> or
38 <em class=
"parameter"><code>size
</code></em> is negative, or if together they define a region of memory
39 that extends beyond the buffer object's allocated data store.
41 <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>.
43 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if the buffer object being queried is mapped.
44 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
45 <a href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>,
46 <a href=
"glBufferData.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBufferData
</span></span></a>,
47 <a href=
"glBufferSubData.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBufferSubData
</span></span></a>,
48 <a href=
"glMapBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glMapBuffer
</span></span></a>,
49 <a href=
"glUnmapBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glUnmapBuffer
</span></span></a>
50 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
51 Copyright
<span class=
"trademark"></span>©
2005 Addison-Wesley.
52 This material may be distributed subject to the terms and conditions set forth in
53 the Open Publication License, v
1.0,
8 June
1999.
54 <a href=
"http://opencontent.org/openpub/" target=
"_top">http://opencontent.org/openpub/
</a>.
55 </p></div></div></body></html>
HCoop / clinton / guile-figl.git / blob