/
glGetBufferPointerv.xhtml
45 lines (45 loc) · 4.88 KB
/
glGetBufferPointerv.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
36
37
38
39
40
41
42
43
44
45
<div class="refentry" lang="en" xml:lang="en"><a id="glGetBufferPointerv"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetBufferPointerv — return the pointer to a mapped buffer object's data store</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table><tr><td><code class="funcdef">void <b class="fsfunc">glGetBufferPointerv</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLvoid ** </td><td><var class="pdparam">params</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>
Specifies the target buffer object.
The symbolic constant must be <code class="constant">GL_ARRAY_BUFFER</code>,
<code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>,
<code class="constant">GL_PIXEL_PACK_BUFFER</code>, or
<code class="constant">GL_PIXEL_UNPACK_BUFFER</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
Specifies the pointer to be returned. The symbolic constant must be <code class="constant">GL_BUFFER_MAP_POINTER</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
Returns the pointer value specified by <em class="parameter"><code>pname</code></em>.
</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetBufferPointerv</code> returns pointer information. <em class="parameter"><code>pname</code></em> is a symbolic constant
indicating the pointer to be returned, which must be <code class="constant">GL_BUFFER_MAP_POINTER</code>, the pointer
to which the buffer object's data store is mapped. If the data store is not currently mapped, <code class="constant">NULL</code> is returned.
<em class="parameter"><code>params</code></em> is a pointer to a location in which to place the returned pointer value.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
If an error is generated,
no change is made to the contents of <em class="parameter"><code>params</code></em>.
</p><p>
<code class="function">glGetBufferPointerv</code> is available only if the GL version is 1.5 or greater.
</p><p>
Targets <code class="constant">GL_PIXEL_PACK_BUFFER</code> and <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> are available
only if the GL version is 2.1 or greater.
</p><p>
The initial value for the pointer is <code class="constant">NULL</code>.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> or <em class="parameter"><code>pname</code></em> is not an
accepted value.
</p><p>
<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>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glGetBufferPointerv</code>
is executed between the execution of <a class="citerefentry" href="glBegin"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
and the corresponding execution of <a class="citerefentry" href="glEnd"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
<a class="citerefentry" href="glMapBuffer"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>
</p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2005 Addison-Wesley.
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>