forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glBindBufferRange.xhtml
238 lines (237 loc) · 12 KB
/
glBindBufferRange.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<div class="refentry" id="glBindBufferRange">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glBindBufferRange — bind a range within a buffer object to an indexed buffer target</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glBindBufferRange</strong>(</code>
</td>
<td>GLenum<var class="pdparam">target</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint<var class="pdparam">index</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint<var class="pdparam">buffer</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLintptr<var class="pdparam">offset</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizeiptr<var class="pdparam">size</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>target</code>
</em>
</span>
</dt>
<dd>
<p>
Specify the target of the bind operation. <em class="parameter"><code>target</code></em> must be
one of <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, <code class="constant">GL_SHADER_STORAGE_BUFFER</code>,
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code> or <code class="constant">GL_UNIFORM_BUFFER</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>index</code>
</em>
</span>
</dt>
<dd>
<p>
Specify the index of the binding point within the array specified by <em class="parameter"><code>target</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>buffer</code>
</em>
</span>
</dt>
<dd>
<p>
The name of a buffer object to bind to the specified binding point.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>offset</code>
</em>
</span>
</dt>
<dd>
<p>
The starting offset in basic machine units into the buffer object <em class="parameter"><code>buffer</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>size</code>
</em>
</span>
</dt>
<dd>
<p>
The amount of data in machine units that can be read from the buffet object while used as an indexed target.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glBindBufferRange</code> binds a range of the buffer object <em class="parameter"><code>buffer</code></em>
represented by <em class="parameter"><code>offset</code></em> and <em class="parameter"><code>size</code></em> to the
binding point at index <em class="parameter"><code>index</code></em> of the array of targets specified by <em class="parameter"><code>target</code></em>.
Each <em class="parameter"><code>target</code></em> represents an indexed array of buffer binding points, as well
as a single general binding point that can be used by other buffer manipulation functions such as
<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a> or
<a class="citerefentry" href="glMapBufferRange"><span class="citerefentry"><span class="refentrytitle">glMapBufferRange</span></span></a>. In addition to binding
a range of <em class="parameter"><code>buffer</code></em> to the indexed buffer binding target, <code class="function">glBindBufferBase</code>
also binds the range to the generic buffer binding point specified by <em class="parameter"><code>target</code></em>.
</p>
<p>
<em class="parameter"><code>offset</code></em> specifies the offset in basic machine units into the buffer object
<em class="parameter"><code>buffer</code></em> and <em class="parameter"><code>size</code></em> specifies the amount of data that
can be read from the buffer object while used as an indexed target.
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
The <code class="constant">GL_ATOMIC_COUNTER_BUFFER</code> and <code class="constant">GL_SHADER_STORAGE_BUFFER</code>
targets are available only if the GL ES version is 3.1 or greater.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not
<code class="constant">GL_ATOMIC_COUNTER_BUFFER</code>, <code class="constant">GL_SHADER_STORAGE_BUFFER</code>,
<code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code> or <code class="constant">GL_UNIFORM_BUFFER</code>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater
than or equal to the number of <em class="parameter"><code>target</code></em>-specific indexed binding points.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>buffer</code></em> is not
zero and <em class="parameter"><code>size</code></em> is less than or equal to zero.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is
<code class="constant">GL_ATOMIC_COUNTER_BUFFER</code> or <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>
and <em class="parameter"><code>size</code></em> or <em class="parameter"><code>offset</code></em> are not multiples of 4.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is
<code class="constant">GL_SHADER_STORAGE_BUFFER</code> and <em class="parameter"><code>offset</code></em> is not a multiple of
<code class="constant">GL_SHADER_STORAGE_BUFFER_OFFSET_ALIGNMENT</code>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is
<code class="constant">GL_UNIFORM_BUFFER</code> and <em class="parameter"><code>offset</code></em> is not a multiple of
<code class="constant">GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</code>.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_ATOMIC_COUNTER_BUFFER_BINDINGS</code>,
<code class="constant">GL_MAX_SHADER_STORAGE_BUFFER_BINDINGS</code>, <code class="constant">GL_MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS</code>,
<code class="constant">GL_MAX_UNIFORM_BUFFER_BINDINGS</code>, <code class="constant">GL_SHADER_STORAGE_BUFFER_OFFSET_ALIGNMENT</code>,
or <code class="constant">GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</code>.
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>API Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="3">
<span class="bold"><strong>OpenGL ES API Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">glBindBufferRange</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glGenBuffers"><span class="citerefentry"><span class="refentrytitle">glGenBuffers</span></span></a>,
<a class="citerefentry" href="glDeleteBuffers"><span class="citerefentry"><span class="refentrytitle">glDeleteBuffers</span></span></a>,
<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
<a class="citerefentry" href="glBindBufferBase"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>,
<a class="citerefentry" href="glMapBufferRange"><span class="citerefentry"><span class="refentrytitle">glMapBufferRange</span></span></a>,
<a class="citerefentry" href="glUnmapBuffer"><span class="citerefentry"><span class="refentrytitle">glUnmapBuffer</span></span></a>,
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2010-2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p>
</div>
</div>