forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glBindImageTextures.xhtml
274 lines (270 loc) · 15.1 KB
/
glBindImageTextures.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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<div class="refentry" id="glBindImageTextures">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glBindImageTextures — bind one or more named texture images to a sequence of consecutive image units</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">glBindImageTextures</strong>(</code>
</td>
<td>GLuint <var class="pdparam">first</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">count</var>, </td>
</tr>
<tr>
<td> </td>
<td>const GLuint *<var class="pdparam">textures</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>first</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the first image unit to which a texture is to be bound.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>count</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the number of textures to bind.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>textures</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the address of an array of names of existing texture objects.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glBindImageTextures</code> binds images from an array of existing texture objects to a specified
number of consecutive image units. <em class="parameter"><code>count</code></em> specifies the number of texture
objects whose names are stored in the array <em class="parameter"><code>textures</code></em>. That number
of texture names are read from the array and bound to the <em class="parameter"><code>count</code></em> consecutive
texture units starting from <em class="parameter"><code>first</code></em>.
If the name zero appears in the <em class="parameter"><code>textures</code></em> array, any existing binding
to the image unit is reset. Any non-zero entry in <em class="parameter"><code>textures</code></em> must be the
name of an existing texture object. When a non-zero entry in <em class="parameter"><code>textures</code></em> is
present, the image at level zero is bound, the binding is considered layered, with the first
layer set to zero, and the image is bound for read-write access. The image unit format
parameter is taken from the internal format of the image at level zero of the texture object.
For cube map textures, the internal format of the positive X image of level zero is used.
If <em class="parameter"><code>textures</code></em> is <code class="constant">NULL</code> then it is as
if an appropriately sized array containing only zeros had been specified.
</p>
<p>
<code class="function">glBindImageTextures</code> is equivalent to the following pseudo code:
</p>
<pre class="programlisting"> for (i = 0; i < count; i++) {
if (textures == NULL || textures[i] = 0) {
glBindImageTexture(first + i, 0, 0, GL_FALSE, 0, GL_READ_ONLY, GL_R8);
} else {
glBindImageTexture(first + i, textures[i], 0, GL_TRUE, 0, GL_READ_WRITE, lookupInternalFormat(textures[i]));
}
}</pre>
<p>
Each entry in <em class="parameter"><code>textures</code></em> will be checked individually and if found
to be invalid, the state for that image unit will not be changed and an error will be
generated. However, the state for other texture image units referenced by the command will still
be updated.
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
<code class="function">glBindImageTextures</code> is available only if the GL version is 4.4 or higher.
</p>
<p>
Note that because <code class="function">glBindImageTextures</code> cannot create new textures (even if
a name passed has been previously generated by call to <a class="citerefentry" href="glGenTextures"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>),
names pased to <code class="function">glBindTextures</code> must have been bound at least once previously
via a call to <a class="citerefentry" href="glBindTexture"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>first</code></em> + <em class="parameter"><code>count</code></em> is greater
than the number of image units supported by the implementation.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if any value in <em class="parameter"><code>textures</code></em> is
not zero or the name of an existing texture object.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> error is generated if the internal format of the
level zero texture image of any texture in textures is not supported.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> error is generated if the width, height, or depth
of the level zero texture image of any texture in textures is zero.
</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_TEXTURE_BINDING_1D</code>,
<code class="constant">GL_TEXTURE_BINDING_2D</code>, <code class="constant">GL_TEXTURE_BINDING_3D</code>, <code class="constant">GL_TEXTURE_BINDING_1D_ARRAY</code>,
<code class="constant">GL_TEXTURE_BINDING_2D_ARRAY</code>, <code class="constant">GL_TEXTURE_BINDING_RECTANGLE</code>,
<code class="constant">GL_TEXTURE_BINDING_BUFFER</code>, <code class="constant">GL_TEXTURE_BINDING_CUBE_MAP</code>, <code class="constant">GL_TEXTURE_BINDING_CUBE_MAP</code>,
<code class="constant">GL_TEXTURE_BINDING_CUBE_MAP_ARRAY</code>,
<code class="constant">GL_TEXTURE_BINDING_2D_MULTISAMPLE</code>,
or <code class="constant">GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY</code>.
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>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; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<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="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature 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>2.1</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-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glBindImageTextures</code>
</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; border-right: 2px solid ; ">-</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; border-right: 2px solid ; ">-</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; border-right: 2px solid ; ">-</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="glBindTexture"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>,
<a class="citerefentry" href="glBindTextures"><span class="citerefentry"><span class="refentrytitle">glBindTextures</span></span></a>,
<a class="citerefentry" href="glDeleteTextures"><span class="citerefentry"><span class="refentrytitle">glDeleteTextures</span></span></a>,
<a class="citerefentry" href="glGenTextures"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>,
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>,
<a class="citerefentry" href="glGetTexParameter"><span class="citerefentry"><span class="refentrytitle">glGetTexParameter</span></span></a>,
<a class="citerefentry" href="glIsTexture"><span class="citerefentry"><span class="refentrytitle">glIsTexture</span></span></a>,
<a class="citerefentry" href="glTexStorage1D"><span class="citerefentry"><span class="refentrytitle">glTexStorage1D</span></span></a>,
<a class="citerefentry" href="glTexStorage2D"><span class="citerefentry"><span class="refentrytitle">glTexStorage2D</span></span></a>,
<a class="citerefentry" href="glTexStorage2DMultisample"><span class="citerefentry"><span class="refentrytitle">glTexStorage2DMultisample</span></span></a>,
<a class="citerefentry" href="glTexStorage3D"><span class="citerefentry"><span class="refentrytitle">glTexStorage3D</span></span></a>,
<a class="citerefentry" href="glTexStorage3DMultisample"><span class="citerefentry"><span class="refentrytitle">glTexStorage3DMultisample</span></span></a>,
<a class="citerefentry" href="glTexBuffer"><span class="citerefentry"><span class="refentrytitle">glTexBuffer</span></span></a>,
<a class="citerefentry" href="glTexParameter"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2013-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>