mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-26 12:35:37 +00:00
104 lines
5 KiB
XML
104 lines
5 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
<refentry id="glBindSampler">
|
|
<refmeta>
|
|
<refmetainfo>
|
|
<copyright>
|
|
<year>2010</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</refmetainfo>
|
|
<refentrytitle>glBindSampler</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glBindSampler</refname>
|
|
<refpurpose>bind a named sampler to a texturing target</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glBindSampler</function></funcdef>
|
|
<paramdef>GLuint <parameter>unit</parameter></paramdef>
|
|
<paramdef>GLuint <parameter>sampler</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>unit</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the index of the texture unit to which the sampler is bound.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>sampler</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the name of a sampler.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glBindSampler</function> binds <parameter>sampler</parameter> to the texture unit at index <parameter>unit</parameter>.
|
|
<parameter>sampler</parameter> must be zero or the name of a sampler object previously returned from a call to
|
|
<citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>. <parameter>unit</parameter> must be less than the value
|
|
of <constant>GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS</constant>.
|
|
</para>
|
|
<para>
|
|
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.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="notes"><title>Notes</title>
|
|
<para>
|
|
<function>glBindSampler</function> is available only if the GL version is 3.3 or higher.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>unit</parameter> is greater than or equal to the value of
|
|
<constant>GL_MAX_COMBIED_TEXTURE_IMAGE_UNITS</constant>.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>sampler</parameter> is not zero or a name previously
|
|
returned from a call to <citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>, or if such a name has
|
|
been deleted by a call to <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_SAMPLER_BINDING</constant>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGenSamplers</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetSamplerParameter</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGenTextures</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 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.
|
|
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|