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