upstream-man-pages/man2/xhtml/glGetBufferParameteriv.xml

   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>glGetBufferParameteriv</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetBufferParameteriv"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetBufferParameteriv — return parameters of a buffer object</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">glGetBufferParameteriv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">value</var>, </td></tr><tr><td> </td><td>GLint *  </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>
   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>value</code></em></span></dt><dd><p>
  10                     Specifies the symbolic name of a buffer object parameter.
  11                     Accepted values are <code class="constant">GL_BUFFER_ACCESS</code>, <code class="constant">GL_BUFFER_MAPPED</code>,
  12                     <code class="constant">GL_BUFFER_SIZE</code>, or <code class="constant">GL_BUFFER_USAGE</code>.
  13                 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
  14                     Returns the requested parameter.
  15                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  16             <code class="function">glGetBufferParameteriv</code> returns in <em class="parameter"><code>data</code></em> a selected parameter of the buffer object
  17             specified by <em class="parameter"><code>target</code></em>.
  18         </p><p>
  19             <em class="parameter"><code>value</code></em> names a specific buffer object parameter, as follows:
  20         </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_BUFFER_ACCESS</code></span></dt><dd><p>
  21                         <em class="parameter"><code>params</code></em> returns the access policy set while mapping the buffer object.
  22                         The initial value is <code class="constant">GL_READ_WRITE</code>.
  23                     </p></dd><dt><span class="term"><code class="constant">GL_BUFFER_MAPPED</code></span></dt><dd><p>
  24                         <em class="parameter"><code>params</code></em> returns a flag indicating whether the buffer object is currently
  25                         mapped. The initial value is <code class="constant">GL_FALSE</code>.
  26                     </p></dd><dt><span class="term"><code class="constant">GL_BUFFER_SIZE</code></span></dt><dd><p>
  27                         <em class="parameter"><code>params</code></em> returns the size of the buffer object, measured in bytes.
  28                         The initial value is 0.
  29                     </p></dd><dt><span class="term"><code class="constant">GL_BUFFER_USAGE</code></span></dt><dd><p>
  30                         <em class="parameter"><code>params</code></em> returns the buffer object's usage pattern.  The initial value is
  31                         <code class="constant">GL_STATIC_DRAW</code>.
  32                     </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  33             If an error is generated,
  34             no change is made to the contents of <em class="parameter"><code>data</code></em>.
  35         </p><p>
  36             <code class="function">glGetBufferParameteriv</code> is available only if the GL version is 1.5 or greater.
  37         </p><p>
  38             Targets <code class="constant">GL_PIXEL_PACK_BUFFER</code> and <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> are available
  39             only if the GL version is 2.1 or greater.
  40         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  41             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> or <em class="parameter"><code>value</code></em> is not an
  42             accepted value.
  43         </p><p>
  44             <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>.
  45         </p><p>
  46             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glGetBufferParameteriv</code>
  47             is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
  48             and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  49         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  50             <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
  51             <a class="citerefentry" href="glBufferData.xml"><span class="citerefentry"><span class="refentrytitle">glBufferData</span></span></a>,
  52             <a class="citerefentry" href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
  53             <a class="citerefentry" href="glUnmapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>
  54         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  55             Copyright <span class="trademark"></span>© 2005 Addison-Wesley.
  56             This material may be distributed subject to the terms and conditions set forth in
  57             the Open Publication License, v 1.0, 8 June 1999.
  58             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  59         </p></div></div></body></html>