forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glBindSampler.xhtml
42 lines (42 loc) · 5.17 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
<div class="refentry"><a id="glBindSampler"></a><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 class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><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"><a id="parameters"></a><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"><a id="description"></a><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"><a id="notes"></a><h2>Notes</h2><p>
<code class="function">glBindSampler</code> is available only if the GL version is 3.3 or higher.
</p></div><div class="refsect1"><a id="errors"></a><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_COMBINED_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"><a id="associatedgets"></a><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"><a id="seealso"></a><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"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 2010 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="ulink" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p></div></div></div>