forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glBindSampler.xhtml
157 lines (156 loc) · 7.79 KB
/
glBindSampler.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
<div class="refentry" id="glBindSampler">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glBindSampler — bind a named sampler to a texturing 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">glBindSampler</strong>(</code>
</td>
<td>GLuint <var class="pdparam">unit</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">sampler</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>unit</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the index of the texture unit to which the sampler is bound.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>sampler</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the name of a sampler.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glBindSampler</code> binds <em class="parameter"><code>sampler</code></em> to the texture unit at index <em class="parameter"><code>unit</code></em>.
<em class="parameter"><code>sampler</code></em> must be zero or the name of a sampler object previously returned from a call to
<a class="citerefentry" href="glGenSamplers"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>. <em class="parameter"><code>unit</code></em> must be less than the value
of <code class="constant">GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS</code>.
</p>
<p>
When a sampler object is bound to a texture unit, its state supersedes that of
the texture object bound to that texture unit. If the sampler name zero is bound to
a texture unit, the currently bound texture's sampler state becomes active. A single
sampler object may be bound to multiple texture units simultaneously.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>unit</code></em> is greater than or equal to the value of
<code class="constant">GL_MAX_COMBIED_TEXTURE_IMAGE_UNITS</code>.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>sampler</code></em> is not zero or a name previously
returned from a call to <a class="citerefentry" href="glGenSamplers"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>, or if such a name has
been deleted by a call to <a class="citerefentry" href="glDeleteSamplers"><span class="citerefentry"><span class="refentrytitle">glDeleteSamplers</span></span></a>.
</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_SAMPLER_BINDING</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 ; ">glBindSampler</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="glGenSamplers"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>,
<a class="citerefentry" href="glDeleteSamplers"><span class="citerefentry"><span class="refentrytitle">glDeleteSamplers</span></span></a>,
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>,
<a class="citerefentry" href="glSamplerParameter"><span class="citerefentry"><span class="refentrytitle">glSamplerParameter</span></span></a>,
<a class="citerefentry" href="glGetSamplerParameter"><span class="citerefentry"><span class="refentrytitle">glGetSamplerParameter</span></span></a>,
<a class="citerefentry" href="glGenTextures"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>,
<a class="citerefentry" href="glBindTexture"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>,
<a class="citerefentry" href="glDeleteTextures"><span class="citerefentry"><span class="refentrytitle">glDeleteTextures</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>