HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
| 2 | <!-- saved from url=(0013)about:internet --> | |
| 3 | <?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" /><title>glGetBufferPointerv</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><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 border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><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> | |
| 4 | Specifies the target buffer object. | |
| 5 | The symbolic constant must be <code class="constant">GL_ARRAY_BUFFER</code>, | |
| 6 | <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>, | |
| 7 | <code class="constant">GL_PIXEL_PACK_BUFFER</code>, or | |
| 8 | <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>. | |
| 9 | </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p> | |
| 10 | Specifies the pointer to be returned. The symbolic constant must be <code class="constant">GL_BUFFER_MAP_POINTER</code>. | |
| 11 | </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p> | |
| 12 | Returns the pointer value specified by <em class="parameter"><code>pname</code></em>. | |
| 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">glGetBufferPointerv</code> returns pointer information. <em class="parameter"><code>pname</code></em> is a symbolic constant | |
| 15 | indicating the pointer to be returned, which must be <code class="constant">GL_BUFFER_MAP_POINTER</code>, the pointer | |
| 16 | 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. | |
| 17 | <em class="parameter"><code>params</code></em> is a pointer to a location in which to place the returned pointer value. | |
| 18 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
| 19 | If an error is generated, | |
| 20 | no change is made to the contents of <em class="parameter"><code>params</code></em>. | |
| 21 | </p><p> | |
| 22 | <code class="function">glGetBufferPointerv</code> is available only if the GL version is 1.5 or greater. | |
| 23 | </p><p> | |
| 24 | Targets <code class="constant">GL_PIXEL_PACK_BUFFER</code> and <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> are available | |
| 25 | only if the GL version is 2.1 or greater. | |
| 26 | </p><p> | |
| 27 | The initial value for the pointer is <code class="constant">NULL</code>. | |
| 28 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
| 29 | <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 | |
| 30 | accepted value. | |
| 31 | </p><p> | |
| 32 | <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>. | |
| 33 | </p><p> | |
| 34 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glGetBufferPointerv</code> | |
| 35 | is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> | |
| 36 | and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>. | |
| 37 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
| 38 | <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>, | |
| 39 | <a class="citerefentry" href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a> | |
| 40 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 41 | Copyright <span class="trademark"></span>© 2005 Addison-Wesley. | |
| 42 | This material may be distributed subject to the terms and conditions set forth in | |
| 43 | the Open Publication License, v 1.0, 8 June 1999. | |
| 44 | <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 45 | </p></div></div></body></html> |