[clinton/guile-figl.git] / upstream-doc / manglsl / gl_NumSamples.xml

<?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_NumSamples">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>gl_NumSamples</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>gl_NumSamples</refname>\r
        <refpurpose>contains the total number of samples in the framebuffer</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <function>in int gl_NumSamples;</function>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>gl_NumSamples</function> is a fragment language input variable that contains\r
            the number of samples in the framebuffer, or 1 if rendering to a non-multisample framebuffer.\r
            <function>gl_NumSamples</function> is the sample count of the framebuffer regardless\r
            of whether multisample rasterization is enabled or not.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="versions"><title>Version Support</title>\r
        <informaltable frame="topbot">\r
            <tgroup cols="3" 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
                <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
                    </row>\r
                    <row>\r
                        <entry>\r
                            gl_NumSamples\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
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>gl_SamplePosition</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>gl_SampleID</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
Commit	Line	Data
7faf1d71 AW	1	<?xml version="1.0" encoding="UTF-8"?>\r
	2	<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
	3	"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
	4	<refentry id="gl_NumSamples">\r
	5	<refmeta>\r
	6	<refmetainfo>\r
	7	<copyright>\r
	8	<year>2011</year>\r
	9	<holder>Khronos Group</holder>\r
	10	</copyright>\r
	11	</refmetainfo>\r
	12	<refentrytitle>gl_NumSamples</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>gl_NumSamples</refname>\r
	17	<refpurpose>contains the total number of samples in the framebuffer</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>Declaration</title>\r
	20	<funcsynopsis>\r
	21	<function>in int gl_NumSamples;</function>\r
	22	</funcsynopsis>\r
	23	</refsynopsisdiv>\r
	24	<refsect1 id="description"><title>Description</title>\r
	25	<para>\r
	26	<function>gl_NumSamples</function> is a fragment language input variable that contains\r
	27	the number of samples in the framebuffer, or 1 if rendering to a non-multisample framebuffer.\r
	28	<function>gl_NumSamples</function> is the sample count of the framebuffer regardless\r
	29	of whether multisample rasterization is enabled or not.\r
	30	</para>\r
	31	</refsect1>\r
	32	<refsect1 id="versions"><title>Version Support</title>\r
	33	<informaltable frame="topbot">\r
	34	<tgroup cols="3" align="left">\r
	35	<colspec colwidth="1.1*" />\r
	36	<colspec colwidth="1*" align="center" />\r
	37	<colspec colwidth="1*" align="center" />\r
	38	<colspec colwidth="1*" align="center" />\r
	39	<colspec colwidth="1*" align="center" />\r
	40	<colspec colwidth="1*" align="center" />\r
	41	<colspec colwidth="1*" align="center" />\r
	42	<colspec colwidth="1*" align="center" />\r
	43	<colspec colwidth="1*" align="center" />\r
	44	<thead>\r
	45	<row>\r
	46	<entry rowsep="1" align="left"><emphasis role="bold">\r
	47	Variable\r
	48	</emphasis></entry>\r
	49	<entry rowsep="1" align="left"><emphasis role="bold">\r
	50	Version 1.10\r
	51	</emphasis></entry>\r
	52	<entry rowsep="1" align="left"><emphasis role="bold">\r
	53	Version 1.20\r
	54	</emphasis></entry>\r
	55	<entry rowsep="1" align="left"><emphasis role="bold">\r
	56	Version 1.30\r
	57	</emphasis></entry>\r
	58	<entry rowsep="1" align="left"><emphasis role="bold">\r
	59	Version 1.40\r
	60	</emphasis></entry>\r
	61	<entry rowsep="1" align="left"><emphasis role="bold">\r
	62	Version 1.50\r
	63	</emphasis></entry>\r
	64	<entry rowsep="1" align="left"><emphasis role="bold">\r
65	Version 3.30\r
66	</emphasis></entry>\r
67	<entry rowsep="1" align="left"><emphasis role="bold">\r
68	Version 4.00\r
69	</emphasis></entry>\r
70	<entry rowsep="1" align="left"><emphasis role="bold">\r
71	Version 4.10\r
72	</emphasis></entry>\r
73	</row>\r
74	<row>\r
75	<entry>\r
76	gl_NumSamples\r
77	</entry>\r
78	<entry>\r
79	<emphasis>-</emphasis> <!-- 1.10, OpenGL 2.0 -->\r
80	</entry>\r
81	<entry>\r
82	<emphasis>-</emphasis> <!-- 1.20, OpenGL 2.1 -->\r
83	</entry>\r
84	<entry>\r
85	<emphasis>-</emphasis> <!-- 1.30, OpenGL 3.0 -->\r
86	</entry>\r
87	<entry>\r
88	<emphasis>-</emphasis> <!-- 1.40, OpenGL 3.1 -->\r
89	</entry>\r
90	<entry>\r
91	<emphasis>-</emphasis> <!-- 1.50, OpenGL 3.2 -->\r
92	</entry>\r
93	<entry>\r
94	<emphasis>-</emphasis> <!-- 3.30, OpenGL 3.3 -->\r
95	</entry>\r
96	<entry>\r
97	<emphasis>Y</emphasis> <!-- 4.00, OpenGL 4.0 -->\r
98	</entry>\r
99	<entry>\r
100	<emphasis>Y</emphasis> <!-- 4.10, OpenGL 4.1 -->\r
101	</entry>\r
102	</row>\r
103	</thead>\r
104	</tgroup>\r
105	</informaltable>\r
106	</refsect1>\r
107	<refsect1 id="seealso"><title>See Also</title>\r
108	<para>\r
109	<citerefentry><refentrytitle>gl_SamplePosition</refentrytitle></citerefentry>,\r
110	<citerefentry><refentrytitle>gl_SampleID</refentrytitle></citerefentry>\r
111	</para>\r
112	</refsect1>\r
113	<refsect1 id="Copyright"><title>Copyright</title>\r
114	<para>\r
115	Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
116	This material may be distributed subject to the terms and conditions set forth in \r
117	the Open Publication License, v 1.0, 8 June 1999.\r
118	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
119	</para>\r
120	</refsect1>\r
121	</refentry>\r