upstream-man-pages/man3/xhtml/glBindBuffer.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>glBindBuffer</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glBindBuffer"><a id="glBindBuffer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindBuffer — bind a named buffer object</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glBindBuffer</b>(</code></td><td>GLenum <var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLuint <var class="pdparam">buffer</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><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 to which the buffer object is bound.
   6                     The symbolic constant must be
   7                     <code class="constant">GL_ARRAY_BUFFER</code>,
   8                     <code class="constant">GL_COPY_READ_BUFFER</code>,
   9                     <code class="constant">GL_COPY_WRITE_BUFFER</code>,
  10                     <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>,
  11                     <code class="constant">GL_PIXEL_PACK_BUFFER</code>,
  12                     <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>,
  13                     <code class="constant">GL_TEXTURE_BUFFER</code>,
  14                     <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>, or
  15                     <code class="constant">GL_UNIFORM_BUFFER</code>.
  16                 </p></dd><dt><span class="term"><em class="parameter"><code>buffer</code></em></span></dt><dd><p>
  17                     Specifies the name of a buffer object.
  18                 </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
  19             <code class="function">glBindBuffer</code> binds a buffer object to the specified buffer binding point. Calling <code class="function">glBindBuffer</code> with
  20             <em class="parameter"><code>target</code></em> set to one of the accepted symbolic constants and <em class="parameter"><code>buffer</code></em> set to the name
  21             of a buffer object binds that buffer object name to the target. If no buffer object with name <em class="parameter"><code>buffer</code></em>
  22             exists, one is created with that name. When a buffer object is bound to a target, the previous binding for that
  23             target is automatically broken.
  24         </p><p>
  25             Buffer object names are unsigned integers. The value zero is reserved, but
  26             there is no default buffer object for each buffer object target. Instead, <em class="parameter"><code>buffer</code></em> set to zero
  27             effectively unbinds any buffer object previously bound, and restores client memory usage for that buffer object target (if supported for that target).
  28             Buffer object names and the corresponding buffer object contents are local to
  29             the shared object space of the current
  30             GL rendering context;
  31             two rendering contexts share buffer object names only if they
  32             explicitly enable sharing between contexts through the appropriate GL windows interfaces functions.
  33         </p><p>
  34             <a class="citerefentry" href="glGenBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenBuffers</span></span></a> must be used to generate a set of unused buffer object names.
  35         </p><p>
  36             The state of a buffer object immediately after it is first bound is an unmapped zero-sized memory buffer with
  37             <code class="constant">GL_READ_WRITE</code> access and <code class="constant">GL_STATIC_DRAW</code> usage.
  38         </p><p>
  39             While a non-zero buffer object name is bound, GL operations on the target to which it is
  40             bound affect the bound buffer object, and queries of the target to which it is bound return state
  41             from the bound buffer object. While buffer object name zero is bound, as in the initial state,
  42             attempts to modify or query state on the target to which it is bound generates an
  43             <code class="constant">GL_INVALID_OPERATION</code> error.
  44         </p><p>
  45             When a non-zero buffer object is bound to the <code class="constant">GL_ARRAY_BUFFER</code> target,
  46             the vertex array pointer parameter is interpreted as an offset within the
  47             buffer object measured in basic machine units.
  48         </p><p>
  49             While a non-zero buffer object is bound to the <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code> target,
  50             the indices parameter of <a class="citerefentry" href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
  51             <a class="citerefentry" href="glDrawElementsInstanced.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsInstanced</span></span></a>,
  52             <a class="citerefentry" href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
  53             <a class="citerefentry" href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
  54             <a class="citerefentry" href="glDrawRangeElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElementsBaseVertex</span></span></a>,
  55             <a class="citerefentry" href="glMultiDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>, or
  56             <a class="citerefentry" href="glMultiDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElementsBaseVertex</span></span></a> is interpreted as an
  57             offset within the buffer object measured in basic machine units.
  58         </p><p>
  59             While a non-zero buffer object is bound to the <code class="constant">GL_PIXEL_PACK_BUFFER</code> target,
  60             the following commands are affected: <a class="citerefentry" href="glGetCompressedTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetCompressedTexImage</span></span></a>,
  61             <a class="citerefentry" href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>, and
  62             <a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>. The pointer parameter is
  63             interpreted as an offset within the buffer object measured in basic machine units.
  64         </p><p>
  65             While a non-zero buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target,
  66             the following commands are affected:
  67             <a class="citerefentry" href="glCompressedTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage1D</span></span></a>,
  68             <a class="citerefentry" href="glCompressedTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>,
  69             <a class="citerefentry" href="glCompressedTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage3D</span></span></a>,
  70             <a class="citerefentry" href="glCompressedTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage1D</span></span></a>,
  71             <a class="citerefentry" href="glCompressedTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage2D</span></span></a>,
  72             <a class="citerefentry" href="glCompressedTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage3D</span></span></a>,
  73             <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
  74             <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
  75             <a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
  76             <a class="citerefentry" href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
  77             <a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>, and
  78             <a class="citerefentry" href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>. The pointer parameter is
  79             interpreted as an offset within the buffer object measured in basic machine units.
  80         </p><p>
  81             The buffer targets <code class="constant">GL_COPY_READ_BUFFER</code> and <code class="constant">GL_COPY_WRITE_BUFFER</code>
  82             are provided to allow <a class="citerefentry" href="glCopyBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glCopyBufferSubData</span></span></a>
  83             to be used without disturbing the state of other bindings. However, <a class="citerefentry" href="glCopyBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glCopyBufferSubData</span></span></a>
  84             may be used with any pair of buffer binding points.
  85         </p><p>
  86             The <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code> buffer binding point may be passed to <code class="function">glBindBuffer</code>,
  87             but will not directly affect transform feedback state. Instead, the indexed <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>
  88             bindings must be used through a call to <a class="citerefentry" href="glBindBufferBase.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>
  89             or <a class="citerefentry" href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>. This will affect the generic
  90             <code class="constant">GL_TRANSFORM_FEEDABCK_BUFFER</code> binding.
  91         </p><p>
  92             Likewise, the <code class="constant">GL_UNIFORM_BUFFER</code> buffer binding point may be used, but does not directly affect
  93             uniform buffer state. <a class="citerefentry" href="glBindBufferBase.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>
  94             or <a class="citerefentry" href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a> must be used to bind a buffer to
  95             an indexed uniform buffer binding point.
  96         </p><p>
  97             A buffer object binding created with <code class="function">glBindBuffer</code> remains active until a different
  98             buffer object name is bound to the same target, or until the bound buffer object is
  99             deleted with <a class="citerefentry" href="glDeleteBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteBuffers</span></span></a>.
 100         </p><p>
 101             Once created, a named buffer object may be re-bound to any target as often as needed. However,
 102             the GL implementation may make choices about how to optimize the storage of a buffer object based
 103             on its initial binding target.
 104         </p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>
 105             The <code class="constant">GL_COPY_READ_BUFFER</code>, <code class="constant">GL_UNIFORM_BUFFER</code> and
 106             <code class="constant">GL_TEXTURE_BUFFER</code> targets are available only if the GL version is 3.1 or greater.
 107         </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p>
 108             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable
 109             values.
 110         </p><p>
 111             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>buffer</code></em> is not a name previously returned
 112             from a call to <a class="citerefentry" href="glGenBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenBuffers</span></span></a>.
 113         </p></div><div class="refsect1" title="Associated Gets"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
 114             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_ARRAY_BUFFER_BINDING</code>
 115         </p><p>
 116             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COPY_READ_BUFFER_BINDING</code>
 117         </p><p>
 118             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COPY_WRITE_BUFFER_BINDING</code>
 119         </p><p>
 120             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_ELEMENT_ARRAY_BUFFER_BINDING</code>
 121         </p><p>
 122             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_PACK_BUFFER_BINDING</code>
 123         </p><p>
 124             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code>
 125         </p><p>
 126             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER_BINDING</code>
 127         </p><p>
 128             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_UNIFORM_BUFFER_BINDING</code>
 129         </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
 130             <a class="citerefentry" href="glGenBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenBuffers</span></span></a>,
 131             <a class="citerefentry" href="glBindBufferBase.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>,
 132             <a class="citerefentry" href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>,
 133             <a class="citerefentry" href="glMapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glMapBuffer</span></span></a>,
 134             <a class="citerefentry" href="glUnmapBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>,
 135             <a class="citerefentry" href="glDeleteBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteBuffers</span></span></a>,
 136             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>,
 137             <a class="citerefentry" href="glIsBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glIsBuffer</span></span></a>
 138         </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
 139             Copyright <span class="trademark"></span>© 2005 Addison-Wesley.
 140             This material may be distributed subject to the terms and conditions set forth in
 141             the Open Publication License, v 1.0, 8 June 1999.
 142             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
 143         </p></div></div></body></html>