upstream-man-pages/man3/xhtml/glSampleMaski.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glSampleMaski</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="refentry" title="glSampleMaski"><a id="glSampleMaski"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glSampleMaski — set the value of a sub-word of the sample mask</p></div><div class="refsynopsisdiv" title="C Specification"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">glSampleMaski</b>(</code></td><td>GLuint <var class="pdparam">maskNumber</var>, </td></tr><tr><td> </td><td>GLbitfield <var class="pdparam">mask</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Parameters"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>maskNumber</code></em></span></dt><dd><p>
   5                     Specifies which 32-bit sub-word of the sample mask to update.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>mask</code></em></span></dt><dd><p>
   7                     Specifies the new value of the mask sub-word.
   8                 </p></dd></dl></div></div><div class="refsect1" title="Description"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">glSampleMaski</code> sets one 32-bit sub-word of the multi-word sample mask, <code class="constant">GL_SAMPLE_MASK_VALUE</code>.
  10         </p><p>
  11             <em class="parameter"><code>maskIndex</code></em> specifies which 32-bit sub-word of the sample mask to update, and <em class="parameter"><code>mask</code></em> specifies
  12             the new value to use for that sub-word. <em class="parameter"><code>maskIndex</code></em> must be less than the value of
  13             <code class="constant">GL_MAX_SAMPLE_MASK_WORDS</code>. Bit <span class="emphasis"><em>B</em></span> of mask word <span class="emphasis"><em>M</em></span> corresponds to sample
  14             32 x <span class="emphasis"><em>M</em></span> + <span class="emphasis"><em>B</em></span>.
  15         </p></div><div class="refsect1" title="Notes"><a id="notes"></a><h2>Notes</h2><p>
  16             <code class="function">glSampleMaski</code> is available only if the GL version is 3.2 or greater, or if the <code class="code">ARB_texture_multisample</code>
  17             extension is supported.
  18         </p></div><div class="refsect1" title="Errors"><a id="errors"></a><h2>Errors</h2><p>
  19             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>maskIndex</code></em> is greater than or equal to the value
  20             of <code class="constant">GL_MAX_SAMPLE_MASK_WORDS</code>.
  21         </p></div><div class="refsect1" title="See Also"><a id="seealso"></a><h2>See Also</h2><p>
  22             <a class="citerefentry" href="glGenRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glGenRenderbuffers</span></span></a>,
  23             <a class="citerefentry" href="glBindRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindRenderbuffer</span></span></a>,
  24             <a class="citerefentry" href="glRenderbufferStorageMultisample.xml"><span class="citerefentry"><span class="refentrytitle">glRenderbufferStorageMultisample</span></span></a>,
  25             <a class="citerefentry" href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>,
  26             <a class="citerefentry" href="glDeleteRenderbuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDeleteRenderbuffers</span></span></a>
  27         </p></div><div class="refsect1" title="Copyright"><a id="Copyright"></a><h2>Copyright</h2><p>
  28             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  29             This material may be distributed subject to the terms and conditions set forth in
  30             the Open Publication License, v 1.0, 8 June 1999.
  31             <a class="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  32         </p></div></div></body></html>