rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glBindSampler.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3<!-- saved from url=(0013)about:internet -->
4<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glBindSampler - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><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 border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glBindSampler</b>(</code></td><td>GLuint  </td><td><var class="pdparam">unit</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">sampler</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>unit</code></em></span></dt><dd><p>
5 Specifies the index of the texture unit to which the sampler is bound.
6 </p></dd><dt><span class="term"><em class="parameter"><code>sampler</code></em></span></dt><dd><p>
7 Specifies the name of a sampler.
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <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>.
10 <em class="parameter"><code>sampler</code></em> must be zero or the name of a sampler object previously returned from a call to
11 <a href="glGenSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>. <em class="parameter"><code>unit</code></em> must be less than the value
12 of <code class="constant">GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS</code>.
13 </p><p>
14 When a sampler object is bound to a texture unit, its state supersedes that of
15 the texture object bound to that texture unit. If the sampler name zero is bound to
16 a texture unit, the currently bound texture's sampler state becomes active. A single
17 sampler object may be bound to multiple texture units simultaneously.
18 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
19 <code class="function">glBindSampler</code> is available only if the GL version is 3.3 or higher.
20 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
21 <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
22 <code class="constant">GL_MAX_COMBIED_TEXTURE_IMAGE_UNITS</code>.
23 </p><p>
24 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>sampler</code></em> is not zero or a name previously
25 returned from a call to <a href="glGenSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>, or if such a name has
26 been deleted by a call to <a href="glDeleteSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteSamplers</span></span></a>.
27 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
28 <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_SAMPLER_BINDING</code>
29 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
30 <a href="glGenSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glGenSamplers</span></span></a>,
31 <a href="glDeleteSamplers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteSamplers</span></span></a>,
32 <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>,
33 <a href="glSamplerParameter.xml"><span class="citerefentry"><span class="refentrytitle">glSamplerParameter</span></span></a>,
34 <a href="glGetSamplerParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetSamplerParameter</span></span></a>,
35 <a href="glGenTextures.xml"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>,
36 <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>,
37 <a href="glDeleteTextures.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteTextures</span></span></a>
38 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
39 Copyright <span class="trademark"></span>© 2010 Khronos Group.
40 This material may be distributed subject to the terms and conditions set forth in
41 the Open Publication License, v 1.0, 8 June 1999.
42 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
43 </p></div></div></body></html>