111 lines
5.2 KiB
XML
111 lines
5.2 KiB
XML
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
|
|
|
|
<!-- Converted by db4-upgrade version 1.1 -->
|
|
|
|
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glGenSamplers">
|
|
<info>
|
|
<copyright>
|
|
<year>2010-2014</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</info>
|
|
<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 xml: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 xml: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 used as a parameter to
|
|
<citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>*,
|
|
<citerefentry><refentrytitle>glGetSamplerParameter</refentrytitle></citerefentry>* or
|
|
<citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetSamplerParameter</refentrytitle></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="versions">
|
|
<title>API Version Support</title>
|
|
<informaltable>
|
|
<tgroup cols="4" align="left">
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
|
|
<tbody>
|
|
<row>
|
|
<entry>glGenSamplers</entry>
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='es30']/*)"/>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
<refsect1 xml:id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetSamplerParameter</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glSamplerParameter</refentrytitle></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="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.
|
|
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|