--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
+ "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
+<refentry id="gl_SampleMask">\r
+ <refmeta>\r
+ <refmetainfo>\r
+ <copyright>\r
+ <year>2011</year>\r
+ <holder>Khronos Group</holder>\r
+ </copyright>\r
+ </refmetainfo>\r
+ <refentrytitle>gl_SampleMask</refentrytitle>\r
+ <manvolnum>3G</manvolnum>\r
+ </refmeta>\r
+ <refnamediv>\r
+ <refname>gl_SampleMask</refname>\r
+ <refpurpose>specifies the sample coverage mask for the current fragment</refpurpose>\r
+ </refnamediv>\r
+ <refsynopsisdiv><title>Declaration</title>\r
+ <funcsynopsis>\r
+ <function>out int gl_SampleMask[];</function>\r
+ </funcsynopsis>\r
+ </refsynopsisdiv>\r
+ <refsect1 id="description"><title>Description</title>\r
+ <para>\r
+ <function>gl_SampleMask</function> is a fragment language output array that may be\r
+ used to set the sample mask for the fragment being processed. Coverage for the current\r
+ fragment will become the logical AND of the coverage mask and the output <function>gl_SampleMask</function>.\r
+ That is, setting a bit in <function>gl_SampleMask</function> to zero will cause the\r
+ corresponding sample to be considered uncovered for the purposes of multisample fragment operations. However,\r
+ setting sample mask bits back to one will never enable samples not covered by the original primitive.\r
+ Bit <emphasis>B</emphasis> of mask <function>gl_SampleMask[M]</function> corresponds to sample\r
+ 32 * <emphasis>M</emphasis> + <emphasis>B</emphasis>. This array must be sized in the fragment shader\r
+ either implicitly or explicitly to be the same size as the implementation-dependent maximum\r
+ sample-mask (as an array of 32-bit elements), determined by the maximum number of samples.\r
+ If the fragment shader statically assigns a value to <function>gl_SampleMask</function>, the\r
+ sample mask will be undefined for any array elements of any fragment shader invocation that\r
+ fails to assign a value. If a shader does not statically assign a value to <function>gl_SampleMask</function>,\r
+ the sample mask has no effect on the processing of a fragment.\r
+ If the fragment shader is being evaluated at any frequency other than per-fragment, bits within\r
+ the sample mask not corresponding to the current fragment shader invocation are ignored.\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="versions"><title>Version Support</title>\r
+ <informaltable frame="topbot">\r
+ <tgroup cols="10" align="left">\r
+ <colspec colwidth="1.1*" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <colspec colwidth="1*" align="center" />\r
+ <thead>\r
+ <row>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Variable\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 1.10\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 1.20\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 1.30\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 1.40\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 1.50\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 3.30\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 4.00\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 4.10\r
+ </emphasis></entry>\r
+ <entry rowsep="1" align="left"><emphasis role="bold">\r
+ Version 4.20\r
+ </emphasis></entry>\r
+ </row>\r
+ <row>\r
+ <entry>\r
+ gl_SampleMask\r
+ </entry>\r
+ <entry>\r
+ <emphasis>-</emphasis> <!-- 1.10, OpenGL 2.0 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>-</emphasis> <!-- 1.20, OpenGL 2.1 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>-</emphasis> <!-- 1.30, OpenGL 3.0 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>-</emphasis> <!-- 1.40, OpenGL 3.1 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>-</emphasis> <!-- 1.50, OpenGL 3.2 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>-</emphasis> <!-- 3.30, OpenGL 3.3 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>Y</emphasis> <!-- 4.00, OpenGL 4.0 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>Y</emphasis> <!-- 4.10, OpenGL 4.1 -->\r
+ </entry>\r
+ <entry>\r
+ <emphasis>Y</emphasis> <!-- 4.20, OpenGL 4.2 -->\r
+ </entry>\r
+ </row>\r
+ </thead>\r
+ </tgroup>\r
+ </informaltable>\r
+ </refsect1>\r
+ <refsect1 id="seealso"><title>See Also</title>\r
+ <para>\r
+ <citerefentry><refentrytitle>gl_SampleMaskIn</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>gl_SampleID</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>gl_SamplePosition</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>gl_FragCoord</refentrytitle></citerefentry>\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="Copyright"><title>Copyright</title>\r
+ <para>\r
+ Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
+ This material may be distributed subject to the terms and conditions set forth in \r
+ the Open Publication License, v 1.0, 8 June 1999.\r
+ <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
+ </para>\r
+ </refsect1>\r
+</refentry>\r
HCoop / clinton / guile-figl.git / blobdiff