<div class="refentry" id="gl_SampleMask">

<div class="titlepage"></div>

<div class="refnamediv">

<h2>Name</h2>

<p>gl_SampleMask — specifies the sample coverage mask for the current fragment</p>

</div>

<div class="refsynopsisdiv">

<h2>Declaration</h2>

<code class="fieldsynopsis"><span class="modifier">out </span><span class="type">int </span><span class="varname">gl_SampleMask[] </span>;</code>

</div>

<div class="refsect1" id="description">

<h2>Description</h2>

<p>

<code class="varname">gl_SampleMask</code> is a fragment language output array that may be

used to set the sample mask for the fragment being processed. Coverage for the current

fragment will become the logical AND of the coverage mask and the output <code class="varname">gl_SampleMask</code>.

That is, setting a bit in <code class="varname">gl_SampleMask</code> to zero will cause the

corresponding sample to be considered uncovered for the purposes of multisample fragment operations. However,

setting sample mask bits back to one will never enable samples not covered by the original primitive.

Bit <span class="emphasis"><em>B</em></span> of mask <code class="varname">gl_SampleMask[M]</code> corresponds to sample

32 * <span class="emphasis"><em>M</em></span> + <span class="emphasis"><em>B</em></span>. This array must be sized in the fragment shader

either implicitly or explicitly to be the same size as the implementation-dependent maximum

sample-mask (as an array of 32-bit elements), determined by the maximum number of samples.

If the fragment shader statically assigns a value to <code class="varname">gl_SampleMask</code>, the

sample mask will be undefined for any array elements of any fragment shader invocation that

fails to assign a value. If a shader does not statically assign a value to <code class="varname">gl_SampleMask</code>,

the sample mask has no effect on the processing of a fragment.

If the fragment shader is being evaluated at any frequency other than per-fragment, bits within

the sample mask not corresponding to the current fragment shader invocation are ignored.

</p>

</div>

{$pipelinestall}{$examples}

<div class="refsect1" id="versions">

<h2>Version Support</h2>

<div class="informaltable">

<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">

<colgroup>

<col style="text-align: left; "/>

<col style="text-align: center; " class="firstvers"/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; "/>

<col style="text-align: center; " class="lastvers"/>

</colgroup>

<thead>

<tr>

<th style="text-align: left; border-right: 2px solid ; ">

</th>

<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">

<span class="bold"><strong>OpenGL Shading Language Version</strong></span>

</th>

</tr>

<tr>

<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>Variable Name</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>1.10</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>1.20</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>1.30</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>1.40</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>1.50</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>3.30</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.00</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.10</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.20</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.30</strong></span>

</th>

<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.40</strong></span>

</th>

<th style="text-align: center; border-bottom: 2px solid ; ">

<span class="bold"><strong>4.50</strong></span>

</th>

</tr>

</thead>

<tbody>

<tr>

<td style="text-align: left; border-right: 2px solid ; ">gl_SampleMask</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">-</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; border-right: 2px solid ; ">✔</td>

<td style="text-align: center; ">✔</td>

</tr>

</tbody>

</table>

</div>

</div>

<div class="refsect1" id="seealso">

<h2>See Also</h2>

<p>

<a class="citerefentry" href="gl_SampleMaskIn"><span class="citerefentry"><span class="refentrytitle">gl_SampleMaskIn</span></span></a>,

<a class="citerefentry" href="gl_SampleID"><span class="citerefentry"><span class="refentrytitle">gl_SampleID</span></span></a>,

<a class="citerefentry" href="gl_SamplePosition"><span class="citerefentry"><span class="refentrytitle">gl_SamplePosition</span></span></a>,

<a class="citerefentry" href="gl_FragCoord"><span class="citerefentry"><span class="refentrytitle">gl_FragCoord</span></span></a>

</p>

</div>

<div class="refsect1" id="Copyright">

<h2>Copyright</h2>

<p>

Copyright © 2011-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.

<a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.

</p>

</div>

</div>