upstream-man-pages/man4/glGenSamplers.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glGenSamplers">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glGenSamplers</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glGenSamplers</refname>
  17         <refpurpose>generate sampler object names</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glGenSamplers</function></funcdef>
  23                 <paramdef>GLsizei <parameter>n</parameter></paramdef>
  24                 <paramdef>GLuint *<parameter>samplers</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <!-- eqn: ignoring delim $$ -->
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>n</parameter></term>
  33             <listitem>
  34                 <para>
  35                     Specifies the number of sampler object names to generate.
  36                 </para>
  37             </listitem>
  38         </varlistentry>
  39         <varlistentry>
  40             <term><parameter>samplers</parameter></term>
  41             <listitem>
  42                 <para>
  43                     Specifies an array in which the generated sampler object names are stored.
  44                 </para>
  45             </listitem>
  46         </varlistentry>
  47         </variablelist>
  48     </refsect1>
  49     <refsect1 id="description"><title>Description</title>
  50         <para>
  51             <function>glGenSamplers</function> returns <parameter>n</parameter> sampler object names in <parameter>samplers</parameter>.
  52             There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names
  53             was in use immediately before the call to <function>glGenSamplers</function>.
  54         </para>
  55         <para>
  56             Sampler object names returned by a call to <function>glGenSamplers</function> are not returned by subsequent calls, unless
  57             they are first deleted with <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>.
  58         </para>
  59         <para>
  60             The names returned in <parameter>samplers</parameter> are marked as used, for the purposes of <function>glGenSamplers</function> only,
  61             but they acquire state and type only when they are first bound.
  62         </para>
  63     </refsect1>
  64     <refsect1 id="notes"><title>Notes</title>
  65         <para>
  66             <function>glGenSamplers</function> is available only if the GL version is 3.3 or higher.
  67         </para>
  68     </refsect1>
  69     <refsect1 id="errors"><title>Errors</title>
  70         <para>
  71             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.
  72         </para>
  73     </refsect1>
  74     <refsect1 id="seealso"><title>See Also</title>
  75         <para>
  76             <citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry>,
  77             <citerefentry><refentrytitle>glIsSampler</refentrytitle></citerefentry>,
  78             <citerefentry><refentrytitle>glDeleteSamplers</refentrytitle></citerefentry>
  79         </para>
  80     </refsect1>
  81     <refsect1 id="Copyright"><title>Copyright</title>
  82         <para>
  83             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  84             This material may be distributed subject to the terms and conditions set forth in
  85             the Open Publication License, v 1.0, 8 June 1999.
  86             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  87         </para>
  88     </refsect1>
  89 </refentry>