Opentk/Source/Bind/Specifications/Docs/glGenSamplers.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="glGenSamplers">
    <refentryinfo>
        <copyright>
            <year>2010-2013</year>
            <holder>Khronos Group</holder>
        </copyright>
    </refentryinfo>
    <refmeta>
        <refentrytitle>glGenSamplers</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glGenSamplers</refname>
        <refpurpose>generate sampler object names</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glGenSamplers</function></funcdef>
                <paramdef>GLsizei <parameter>n</parameter></paramdef>
                <paramdef>GLuint *<parameter>samplers</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>n</parameter></term>
            <listitem>
                <para>
                    Specifies the number of sampler object names to generate.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>samplers</parameter></term>
            <listitem>
                <para>
                    Specifies an array in which the generated sampler object names are stored.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glGenSamplers</function> returns <parameter>n</parameter> sampler object names in <parameter>samplers</parameter>.
            There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names
            was in use immediately before the call to <function>glGenSamplers</function>.
        </para>
        <para>
            Sampler object names returned by a call to <function>glGenSamplers</function> are not returned by subsequent calls, unless
            they are first deleted with <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>.
        </para>
        <para>
            The names returned in <parameter>samplers</parameter> are marked as used, for the purposes of <function>glGenSamplers</function> only,
            but they acquire state and type only when they are first bound.
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            <function>glGenSamplers</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>n</parameter> is negative.
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2010-2013 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>