upstream-man-pages/man3/xhtml/glGetBufferPointerv.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>glGetBufferPointerv</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></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>
   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>pname</code></em></span></dt><dd><p>
  16                     Specifies the pointer to be returned.  The symbolic constant must be <code class="constant">GL_BUFFER_MAP_POINTER</code>.
  17                 </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
  18                     Returns the pointer value specified by <em class="parameter"><code>pname</code></em>.
  19                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  20             <code class="function">glGetBufferPointerv</code> returns pointer information. <em class="parameter"><code>pname</code></em> is a symbolic constant
  21             indicating the pointer to be returned, which must be <code class="constant">GL_BUFFER_MAP_POINTER</code>, the pointer
  22             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.
  23             <em class="parameter"><code>params</code></em> is a pointer to a location in which to place the returned pointer value.
  24         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  25             If an error is generated,
  26             no change is made to the contents of <em class="parameter"><code>params</code></em>.
  27         </p><p>
  28             The initial value for the pointer is <code class="constant">NULL</code>.
  29         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  30             <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
  31             accepted value.
  32         </p><p>
  33             <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>.
  34         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  35             <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
  36             <a href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>
  37         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  38             Copyright <span class="trademark"></span>© 2005 Addison-Wesley.
  39             This material may be distributed subject to the terms and conditions set forth in
  40             the Open Publication License, v 1.0, 8 June 1999.
  41             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  42         </p></div></div></body></html>