Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> | |
4 | <refentry id="glTexBuffer"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>2010</year> | |
9 | <holder>Khronos Group</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glTexBuffer</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glTexBuffer</refname> | |
17 | <refpurpose>attach the storage for a buffer object to the active buffer texture</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glTexBuffer</function></funcdef> | |
23 | <paramdef>GLenum <parameter>target</parameter></paramdef> | |
24 | <paramdef>GLenum <parameter>internalFormat</parameter></paramdef> | |
25 | <paramdef>Gluint<parameter>buffer</parameter></paramdef> | |
26 | </funcprototype> | |
27 | </funcsynopsis> | |
28 | </refsynopsisdiv> | |
29 | <refsect1 id="parameters"><title>Parameters</title> | |
30 | <variablelist> | |
31 | <varlistentry> | |
32 | <term><parameter>target</parameter></term> | |
33 | <listitem> | |
34 | <para> | |
35 | Specifies the target of the operation and must be <constant>GL_TEXTURE_BUFFER</constant>. | |
36 | </para> | |
37 | </listitem> | |
38 | </varlistentry> | |
39 | <varlistentry> | |
40 | <term><parameter>internalFormat</parameter></term> | |
41 | <listitem> | |
42 | <para> | |
43 | Specifies the internal format of the data in the store belonging to <parameter>buffer</parameter>. | |
44 | </para> | |
45 | </listitem> | |
46 | </varlistentry> | |
47 | <varlistentry> | |
48 | <term><parameter>buffer</parameter></term> | |
49 | <listitem> | |
50 | <para> | |
51 | Specifies the name of the buffer object whose storage to attach to the active buffer texture. | |
52 | </para> | |
53 | </listitem> | |
54 | </varlistentry> | |
55 | </variablelist> | |
56 | </refsect1> | |
57 | <refsect1 id="description"><title>Description</title> | |
58 | <para> | |
59 | <function>glTexBuffer</function> attaches the storage for the buffer object named <parameter>buffer</parameter> to the active | |
60 | buffer texture, and specifies the internal format for the texel array found in the attached buffer object. If <parameter>buffer</parameter> | |
61 | is zero, any buffer object attached to the buffer texture is detached and no new buffer object is attached. If <parameter>buffer</parameter> | |
62 | is non-zero, it must be the name of an existing buffer object. <parameter>target</parameter> must be <constant>GL_TEXTURE_BUFFER</constant>. | |
63 | <parameter>internalformat</parameter> specifies the storage format, and must be one of the following sized internal formats: | |
64 | </para> | |
65 | <informaltable frame="topbot"> | |
66 | <tgroup cols="8" align="left"> | |
67 | <colspec colnum="1" colname="col1" colwidth="1*"/> | |
68 | <colspec colnum="2" colname="col2" colwidth="2*"/> | |
69 | <colspec colnum="3" colname="col3" colwidth="1.5*"/> | |
70 | <colspec colnum="4" colname="col4" colwidth="1*"/> | |
71 | <colspec colnum="5" colname="col5" colwidth="1*"/> | |
72 | <colspec colnum="6" colname="col6" colwidth="2*"/> | |
73 | <colspec colnum="7" colname="col7" colwidth="1.5*"/> | |
74 | <colspec colnum="8" colname="col8" colwidth="1*"/> | |
75 | <thead> | |
76 | <row> | |
77 | <entry morerows="1" rowsep="1" align="center"></entry> | |
78 | <entry morerows="1" rowsep="1" align="center"></entry> | |
79 | <entry morerows="1" rowsep="1" align="center"></entry> | |
80 | <entry morerows="1" rowsep="1" align="center"></entry> | |
81 | <entry namest="col5" nameend="col8" rowsep="1" align="left"><emphasis role="bold"> | |
82 | Component | |
83 | </emphasis></entry> | |
84 | </row> | |
85 | </thead> | |
86 | <tbody> | |
87 | <row> | |
88 | <entry align="left"><emphasis role="bold">Sized Internal Format</emphasis></entry> | |
89 | <entry align="left"><emphasis role="bold">Base Type</emphasis></entry> | |
90 | <entry align="left"><emphasis role="bold">Components</emphasis></entry> | |
91 | <entry align="left"><emphasis role="bold">Norm</emphasis></entry> | |
92 | <entry align="center">0</entry> | |
93 | <entry align="center">1</entry> | |
94 | <entry align="center">2</entry> | |
95 | <entry align="center">3</entry> | |
96 | </row> | |
97 | <row> | |
98 | <entry align="left"><constant>GL_R8</constant></entry> | |
99 | <entry align="left">ubyte</entry> | |
100 | <entry align="left">1</entry> | |
101 | <entry align="left">YES</entry> | |
102 | <entry align="center">R</entry> | |
103 | <entry align="center">0</entry> | |
104 | <entry align="center">0</entry> | |
105 | <entry align="center">1</entry> | |
106 | </row> | |
107 | <row> | |
108 | <entry align="left"><constant>GL_R16</constant></entry> | |
109 | <entry align="left">ushort</entry> | |
110 | <entry align="left">1</entry> | |
111 | <entry align="left">YES</entry> | |
112 | <entry align="center">R</entry> | |
113 | <entry align="center">0</entry> | |
114 | <entry align="center">0</entry> | |
115 | <entry align="center">1</entry> | |
116 | </row> | |
117 | <row> | |
118 | <entry align="left"><constant>GL_R16F</constant></entry> | |
119 | <entry align="left">half</entry> | |
120 | <entry align="left">1</entry> | |
121 | <entry align="left">NO</entry> | |
122 | <entry align="center">R</entry> | |
123 | <entry align="center">0</entry> | |
124 | <entry align="center">0</entry> | |
125 | <entry align="center">1</entry> | |
126 | </row> | |
127 | <row> | |
128 | <entry align="left"><constant>GL_R32F</constant></entry> | |
129 | <entry align="left">float</entry> | |
130 | <entry align="left">1</entry> | |
131 | <entry align="left">NO</entry> | |
132 | <entry align="center">R</entry> | |
133 | <entry align="center">0</entry> | |
134 | <entry align="center">0</entry> | |
135 | <entry align="center">1</entry> | |
136 | </row> | |
137 | <row> | |
138 | <entry align="left"><constant>GL_R8I</constant></entry> | |
139 | <entry align="left">byte</entry> | |
140 | <entry align="left">1</entry> | |
141 | <entry align="left">NO</entry> | |
142 | <entry align="center">R</entry> | |
143 | <entry align="center">0</entry> | |
144 | <entry align="center">0</entry> | |
145 | <entry align="center">1</entry> | |
146 | </row> | |
147 | <row> | |
148 | <entry align="left"><constant>GL_R16I</constant></entry> | |
149 | <entry align="left">short</entry> | |
150 | <entry align="left">1</entry> | |
151 | <entry align="left">NO</entry> | |
152 | <entry align="center">R</entry> | |
153 | <entry align="center">0</entry> | |
154 | <entry align="center">0</entry> | |
155 | <entry align="center">1</entry> | |
156 | </row> | |
157 | <row> | |
158 | <entry align="left"><constant>GL_R32I</constant></entry> | |
159 | <entry align="left">int</entry> | |
160 | <entry align="left">1</entry> | |
161 | <entry align="left">NO</entry> | |
162 | <entry align="center">R</entry> | |
163 | <entry align="center">0</entry> | |
164 | <entry align="center">0</entry> | |
165 | <entry align="center">1</entry> | |
166 | </row> | |
167 | <row> | |
168 | <entry align="left"><constant>GL_R8UI</constant></entry> | |
169 | <entry align="left">ubyte</entry> | |
170 | <entry align="left">1</entry> | |
171 | <entry align="left">NO</entry> | |
172 | <entry align="center">R</entry> | |
173 | <entry align="center">0</entry> | |
174 | <entry align="center">0</entry> | |
175 | <entry align="center">1</entry> | |
176 | </row> | |
177 | <row> | |
178 | <entry align="left"><constant>GL_R16UI</constant></entry> | |
179 | <entry align="left">ushort</entry> | |
180 | <entry align="left">1</entry> | |
181 | <entry align="left">NO</entry> | |
182 | <entry align="center">R</entry> | |
183 | <entry align="center">0</entry> | |
184 | <entry align="center">0</entry> | |
185 | <entry align="center">1</entry> | |
186 | </row> | |
187 | <row> | |
188 | <entry align="left"><constant>GL_R32UI</constant></entry> | |
189 | <entry align="left">uint</entry> | |
190 | <entry align="left">1</entry> | |
191 | <entry align="left">NO</entry> | |
192 | <entry align="center">R</entry> | |
193 | <entry align="center">0</entry> | |
194 | <entry align="center">0</entry> | |
195 | <entry align="center">1</entry> | |
196 | </row> | |
197 | <row> | |
198 | <entry align="left"><constant>GL_RG8</constant></entry> | |
199 | <entry align="left">ubyte</entry> | |
200 | <entry align="left">2</entry> | |
201 | <entry align="left">YES</entry> | |
202 | <entry align="center">R</entry> | |
203 | <entry align="center">G</entry> | |
204 | <entry align="center">0</entry> | |
205 | <entry align="center">1</entry> | |
206 | </row> | |
207 | <row> | |
208 | <entry align="left"><constant>GL_RG16</constant></entry> | |
209 | <entry align="left">ushort</entry> | |
210 | <entry align="left">2</entry> | |
211 | <entry align="left">YES</entry> | |
212 | <entry align="center">R</entry> | |
213 | <entry align="center">G</entry> | |
214 | <entry align="center">0</entry> | |
215 | <entry align="center">1</entry> | |
216 | </row> | |
217 | <row> | |
218 | <entry align="left"><constant>GL_RG16F</constant></entry> | |
219 | <entry align="left">half</entry> | |
220 | <entry align="left">2</entry> | |
221 | <entry align="left">NO</entry> | |
222 | <entry align="center">R</entry> | |
223 | <entry align="center">G</entry> | |
224 | <entry align="center">0</entry> | |
225 | <entry align="center">1</entry> | |
226 | </row> | |
227 | <row> | |
228 | <entry align="left"><constant>GL_RG32F</constant></entry> | |
229 | <entry align="left">float</entry> | |
230 | <entry align="left">2</entry> | |
231 | <entry align="left">NO</entry> | |
232 | <entry align="center">R</entry> | |
233 | <entry align="center">G</entry> | |
234 | <entry align="center">0</entry> | |
235 | <entry align="center">1</entry> | |
236 | </row> | |
237 | <row> | |
238 | <entry align="left"><constant>GL_RG8I</constant></entry> | |
239 | <entry align="left">byte</entry> | |
240 | <entry align="left">2</entry> | |
241 | <entry align="left">NO</entry> | |
242 | <entry align="center">R</entry> | |
243 | <entry align="center">G</entry> | |
244 | <entry align="center">0</entry> | |
245 | <entry align="center">1</entry> | |
246 | </row> | |
247 | <row> | |
248 | <entry align="left"><constant>GL_RG16I</constant></entry> | |
249 | <entry align="left">short</entry> | |
250 | <entry align="left">2</entry> | |
251 | <entry align="left">NO</entry> | |
252 | <entry align="center">R</entry> | |
253 | <entry align="center">G</entry> | |
254 | <entry align="center">0</entry> | |
255 | <entry align="center">1</entry> | |
256 | </row> | |
257 | <row> | |
258 | <entry align="left"><constant>GL_RG32I</constant></entry> | |
259 | <entry align="left">int</entry> | |
260 | <entry align="left">2</entry> | |
261 | <entry align="left">NO</entry> | |
262 | <entry align="center">R</entry> | |
263 | <entry align="center">G</entry> | |
264 | <entry align="center">0</entry> | |
265 | <entry align="center">1</entry> | |
266 | </row> | |
267 | <row> | |
268 | <entry align="left"><constant>GL_RG8UI</constant></entry> | |
269 | <entry align="left">ubyte</entry> | |
270 | <entry align="left">2</entry> | |
271 | <entry align="left">NO</entry> | |
272 | <entry align="center">R</entry> | |
273 | <entry align="center">G</entry> | |
274 | <entry align="center">0</entry> | |
275 | <entry align="center">1</entry> | |
276 | </row> | |
277 | <row> | |
278 | <entry align="left"><constant>GL_RG16UI</constant></entry> | |
279 | <entry align="left">ushort</entry> | |
280 | <entry align="left">2</entry> | |
281 | <entry align="left">NO</entry> | |
282 | <entry align="center">R</entry> | |
283 | <entry align="center">G</entry> | |
284 | <entry align="center">0</entry> | |
285 | <entry align="center">1</entry> | |
286 | </row> | |
287 | <row> | |
288 | <entry align="left"><constant>GL_RG32UI</constant></entry> | |
289 | <entry align="left">uint</entry> | |
290 | <entry align="left">2</entry> | |
291 | <entry align="left">NO</entry> | |
292 | <entry align="center">R</entry> | |
293 | <entry align="center">G</entry> | |
294 | <entry align="center">0</entry> | |
295 | <entry align="center">1</entry> | |
296 | </row> | |
297 | <row> | |
298 | <entry align="left"><constant>GL_RGB32F</constant></entry> | |
299 | <entry align="left">float</entry> | |
300 | <entry align="left">3</entry> | |
301 | <entry align="left">NO</entry> | |
302 | <entry align="center">R</entry> | |
303 | <entry align="center">G</entry> | |
304 | <entry align="center">B</entry> | |
305 | <entry align="center">1</entry> | |
306 | </row> | |
307 | <row> | |
308 | <entry align="left"><constant>GL_RGB32I</constant></entry> | |
309 | <entry align="left">int</entry> | |
310 | <entry align="left">3</entry> | |
311 | <entry align="left">NO</entry> | |
312 | <entry align="center">R</entry> | |
313 | <entry align="center">G</entry> | |
314 | <entry align="center">B</entry> | |
315 | <entry align="center">1</entry> | |
316 | </row> | |
317 | <row> | |
318 | <entry align="left"><constant>GL_RGB32UI</constant></entry> | |
319 | <entry align="left">uint</entry> | |
320 | <entry align="left">3</entry> | |
321 | <entry align="left">NO</entry> | |
322 | <entry align="center">R</entry> | |
323 | <entry align="center">G</entry> | |
324 | <entry align="center">B</entry> | |
325 | <entry align="center">1</entry> | |
326 | </row> | |
327 | <row> | |
328 | <entry align="left"><constant>GL_RGBA8</constant></entry> | |
329 | <entry align="left">uint</entry> | |
330 | <entry align="left">4</entry> | |
331 | <entry align="left">YES</entry> | |
332 | <entry align="center">R</entry> | |
333 | <entry align="center">G</entry> | |
334 | <entry align="center">B</entry> | |
335 | <entry align="center">A</entry> | |
336 | </row> | |
337 | <row> | |
338 | <entry align="left"><constant>GL_RGBA16</constant></entry> | |
339 | <entry align="left">short</entry> | |
340 | <entry align="left">4</entry> | |
341 | <entry align="left">YES</entry> | |
342 | <entry align="center">R</entry> | |
343 | <entry align="center">G</entry> | |
344 | <entry align="center">B</entry> | |
345 | <entry align="center">A</entry> | |
346 | </row> | |
347 | <row> | |
348 | <entry align="left"><constant>GL_RGBA16F</constant></entry> | |
349 | <entry align="left">half</entry> | |
350 | <entry align="left">4</entry> | |
351 | <entry align="left">NO</entry> | |
352 | <entry align="center">R</entry> | |
353 | <entry align="center">G</entry> | |
354 | <entry align="center">B</entry> | |
355 | <entry align="center">A</entry> | |
356 | </row> | |
357 | <row> | |
358 | <entry align="left"><constant>GL_RGBA32F</constant></entry> | |
359 | <entry align="left">float</entry> | |
360 | <entry align="left">4</entry> | |
361 | <entry align="left">NO</entry> | |
362 | <entry align="center">R</entry> | |
363 | <entry align="center">G</entry> | |
364 | <entry align="center">B</entry> | |
365 | <entry align="center">A</entry> | |
366 | </row> | |
367 | <row> | |
368 | <entry align="left"><constant>GL_RGBA8I</constant></entry> | |
369 | <entry align="left">byte</entry> | |
370 | <entry align="left">4</entry> | |
371 | <entry align="left">NO</entry> | |
372 | <entry align="center">R</entry> | |
373 | <entry align="center">G</entry> | |
374 | <entry align="center">B</entry> | |
375 | <entry align="center">A</entry> | |
376 | </row> | |
377 | <row> | |
378 | <entry align="left"><constant>GL_RGBA16I</constant></entry> | |
379 | <entry align="left">short</entry> | |
380 | <entry align="left">4</entry> | |
381 | <entry align="left">NO</entry> | |
382 | <entry align="center">R</entry> | |
383 | <entry align="center">G</entry> | |
384 | <entry align="center">B</entry> | |
385 | <entry align="center">A</entry> | |
386 | </row> | |
387 | <row> | |
388 | <entry align="left"><constant>GL_RGBA32I</constant></entry> | |
389 | <entry align="left">int</entry> | |
390 | <entry align="left">4</entry> | |
391 | <entry align="left">NO</entry> | |
392 | <entry align="center">R</entry> | |
393 | <entry align="center">G</entry> | |
394 | <entry align="center">B</entry> | |
395 | <entry align="center">A</entry> | |
396 | </row> | |
397 | <row> | |
398 | <entry align="left"><constant>GL_RGBA8UI</constant></entry> | |
399 | <entry align="left">ubyte</entry> | |
400 | <entry align="left">4</entry> | |
401 | <entry align="left">NO</entry> | |
402 | <entry align="center">R</entry> | |
403 | <entry align="center">G</entry> | |
404 | <entry align="center">B</entry> | |
405 | <entry align="center">A</entry> | |
406 | </row> | |
407 | <row> | |
408 | <entry align="left"><constant>GL_RGBA16UI</constant></entry> | |
409 | <entry align="left">ushort</entry> | |
410 | <entry align="left">4</entry> | |
411 | <entry align="left">NO</entry> | |
412 | <entry align="center">R</entry> | |
413 | <entry align="center">G</entry> | |
414 | <entry align="center">B</entry> | |
415 | <entry align="center">A</entry> | |
416 | </row> | |
417 | <row> | |
418 | <entry align="left"><constant>GL_RGBA32UI</constant></entry> | |
419 | <entry align="left">uint</entry> | |
420 | <entry align="left">4</entry> | |
421 | <entry align="left">NO</entry> | |
422 | <entry align="center">R</entry> | |
423 | <entry align="center">G</entry> | |
424 | <entry align="center">B</entry> | |
425 | <entry align="center">A</entry> | |
426 | </row> | |
427 | </tbody> | |
428 | </tgroup> | |
429 | </informaltable> | |
430 | <para> | |
431 | When a buffer object is attached to a buffer texture, the buffer object's data store | |
432 | is taken as the texture's texel array. The number of texels in the buffer texture's | |
433 | texel array is given by | |
434 | </para> | |
435 | <inlineequation> | |
436 | <mml:apply><mml:floor /> | |
437 | <mml:mfrac> | |
438 | <mml:mrow> | |
439 | <mml:mi>buffer_size</mml:mi> | |
440 | </mml:mrow> | |
441 | <mml:mrow> | |
442 | <mml:mi>components</mml:mi><mml:mo> </mml:mo><mml:csymbol><mml:mo>×</mml:mo></mml:csymbol><mml:mo> </mml:mo><mml:mi>sizeof</mml:mi><mml:mo>(</mml:mo><mml:mi>base_type</mml:mi><mml:mo>)</mml:mo> | |
443 | </mml:mrow> | |
444 | </mml:mfrac> | |
445 | </mml:apply> | |
446 | </inlineequation> | |
447 | <para> | |
448 | where <emphasis>buffer_size</emphasis> is the size of the buffer object, in basic machine units and | |
449 | components and base type are the element count and base data type for elements, as specified in the table above. | |
450 | The number of texels in the texel array is then clamped to the implementation-dependent limit <constant>GL_MAX_TEXTURE_BUFFER_SIZE</constant>. | |
451 | When a buffer texture is accessed in a shader, the results of a texel fetch are undefined if the specified texel coordinate is negative, or | |
452 | greater than or equal to the clamped number of texels in the texel array. | |
453 | </para> | |
454 | </refsect1> | |
455 | <refsect1 id="errors"><title>Errors</title> | |
456 | <para> | |
457 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_TEXTURE_BUFFER</constant>. | |
458 | </para> | |
459 | <para> | |
460 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalFormat</parameter> is not one of the accepted tokens. | |
461 | </para> | |
462 | <para> | |
463 | <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>buffer</parameter> is not zero or the name of an existing buffer object. | |
464 | </para> | |
465 | </refsect1> | |
466 | <refsect1 id="notes"><title>Notes</title> | |
467 | <para> | |
468 | <function>glTexBuffer</function> is available only if the GL version is 3.1 or greater. | |
469 | </para> | |
470 | </refsect1> | |
471 | <refsect1 id="associatedgets"><title>Associated Gets</title> | |
472 | <para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> | |
473 | with argument <constant>GL_MAX_TEXTURE_BUFFER_SIZE</constant></para> | |
474 | <para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> | |
475 | with argument <constant>GL_TEXTURE_BINDING_BUFFER</constant></para> | |
476 | <para><citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> | |
477 | with argument <constant>GL_TEXTURE_BUFFER_DATA_STORE_BINDING</constant></para> | |
478 | </refsect1> | |
479 | <refsect1 id="seealso"><title>See Also</title> | |
480 | <para> | |
481 | <citerefentry><refentrytitle>glGenBuffers</refentrytitle></citerefentry>, | |
482 | <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>, | |
483 | <citerefentry><refentrytitle>glBufferData</refentrytitle></citerefentry>, | |
484 | <citerefentry><refentrytitle>glDeleteBuffers</refentrytitle></citerefentry>, | |
485 | <citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>, | |
486 | <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>, | |
487 | <citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry> | |
488 | </para> | |
489 | </refsect1> | |
490 | <refsect1 id="Copyright"><title>Copyright</title> | |
491 | <para> | |
492 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. | |
493 | This material may be distributed subject to the terms and conditions set forth in | |
494 | the Open Publication License, v 1.0, 8 June 1999. | |
495 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
496 | </para> | |
497 | </refsect1> | |
498 | </refentry> |