upstream-doc/man3/glSampleMaski.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="glSampleMaski">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glSampleMaski</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glSampleMaski</refname>
  17         <refpurpose>set the value of a sub-word of the sample mask</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glSampleMaski</function></funcdef>
  23                 <paramdef>GLuint <parameter>maskNumber</parameter></paramdef>
  24                 <paramdef>GLbitfield <parameter>mask</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>maskNumber</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies which 32-bit sub-word of the sample mask to update.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         <varlistentry>
  39             <term><parameter>mask</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies the new value of the mask sub-word.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>glSampleMaski</function> sets one 32-bit sub-word of the multi-word sample mask, <constant>GL_SAMPLE_MASK_VALUE</constant>.
  51         </para>
  52         <para>
  53             <parameter>maskIndex</parameter> specifies which 32-bit sub-word of the sample mask to update, and <parameter>mask</parameter> specifies
  54             the new value to use for that sub-word. <parameter>maskIndex</parameter> must be less than the value of
  55             <constant>GL_MAX_SAMPLE_MASK_WORDS</constant>. Bit <emphasis>B</emphasis> of mask word <emphasis>M</emphasis> corresponds to sample
  56             32 x <emphasis>M</emphasis> + <emphasis>B</emphasis>.
  57         </para>
  58     </refsect1>
  59     <refsect1 id="notes"><title>Notes</title>
  60         <para>
  61             <function>glSampleMaski</function> is available only if the GL version is 3.2 or greater, or if the <code>ARB_texture_multisample</code>
  62             extension is supported.
  63         </para>
  64     </refsect1>
  65     <refsect1 id="errors"><title>Errors</title>
  66         <para>
  67             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>maskIndex</parameter> is greater than or equal to the value
  68             of <constant>GL_MAX_SAMPLE_MASK_WORDS</constant>.
  69         </para>
  70     </refsect1>
  71     <refsect1 id="seealso"><title>See Also</title>
  72         <para>
  73             <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>,
  75             <citerefentry><refentrytitle>glRenderbufferStorageMultisample</refentrytitle></citerefentry>,
  76             <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>,
  77             <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>
  78         </para>
  79     </refsect1>
  80     <refsect1 id="Copyright"><title>Copyright</title>
  81         <para>
  82             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
  83             This material may be distributed subject to the terms and conditions set forth in
  84             the Open Publication License, v 1.0, 8 June 1999.
  85             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  86         </para>
  87     </refsect1>
  88 </refentry>