[clinton/guile-figl.git] / upstream-doc / manglsl / gl_InvocationID.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_InvocationID">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>gl_InvocationID</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>gl_InvocationID</refname>\r
        <refpurpose>contains the invocation index of the current shader</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <function>in int gl_InvocationID;</function>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            In the tessellation control language, <function>gl_InvocationID</function>\r
            contains the index of the output patch vertex assigned to the shader invocation.\r
            It is assigned an integer value in the range [0, N-1] where N is the number of output\r
            patch vertices.\r
        </para>\r
        <para>\r
            In the geometry language, <function>gl_InvocationID</function> identifies\r
            the invocation number assigned to the geometry shader invocation. It is assigned\r
            an integer value in the range [0, N-1] where N is the number of geometry shader\r
            invocations per primitive.\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_InvocationID\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>Y</emphasis><superscript>1</superscript>  <!-- 1.50, OpenGL 3.2 -->\r
                        </entry>\r
                        <entry>\r
                            <emphasis>Y</emphasis><superscript>1</superscript>  <!-- 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
        <para>[1] Versions 1.50 to 3.30 - geometry shaders only.</para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>gl_InstanceID</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_InvocationID">\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_InvocationID</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>gl_InvocationID</refname>\r
	17	<refpurpose>contains the invocation index of the current shader</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>Declaration</title>\r
	20	<funcsynopsis>\r
	21	<function>in int gl_InvocationID;</function>\r
	22	</funcsynopsis>\r
	23	</refsynopsisdiv>\r
	24	<refsect1 id="description"><title>Description</title>\r
	25	<para>\r
	26	In the tessellation control language, <function>gl_InvocationID</function>\r
	27	contains the index of the output patch vertex assigned to the shader invocation.\r
	28	It is assigned an integer value in the range [0, N-1] where N is the number of output\r
	29	patch vertices.\r
	30	</para>\r
	31	<para>\r
	32	In the geometry language, <function>gl_InvocationID</function> identifies\r
	33	the invocation number assigned to the geometry shader invocation. It is assigned\r
	34	an integer value in the range [0, N-1] where N is the number of geometry shader\r
	35	invocations per primitive.\r
	36	</para>\r
	37	</refsect1>\r
	38	<refsect1 id="versions"><title>Version Support</title>\r
	39	<informaltable frame="topbot">\r
	40	<tgroup cols="3" align="left">\r
	41	<colspec colwidth="1.1*" />\r
	42	<colspec colwidth="1*" align="center" />\r
	43	<colspec colwidth="1*" align="center" />\r
	44	<colspec colwidth="1*" align="center" />\r
	45	<colspec colwidth="1*" align="center" />\r
	46	<colspec colwidth="1*" align="center" />\r
	47	<colspec colwidth="1*" align="center" />\r
	48	<colspec colwidth="1*" align="center" />\r
	49	<colspec colwidth="1*" align="center" />\r
	50	<thead>\r
	51	<row>\r
	52	<entry rowsep="1" align="left"><emphasis role="bold">\r
	53	Variable\r
	54	</emphasis></entry>\r
	55	<entry rowsep="1" align="left"><emphasis role="bold">\r
	56	Version 1.10\r
	57	</emphasis></entry>\r
	58	<entry rowsep="1" align="left"><emphasis role="bold">\r
	59	Version 1.20\r
	60	</emphasis></entry>\r
	61	<entry rowsep="1" align="left"><emphasis role="bold">\r
	62	Version 1.30\r
	63	</emphasis></entry>\r
	64	<entry rowsep="1" align="left"><emphasis role="bold">\r
65	Version 1.40\r
66	</emphasis></entry>\r
67	<entry rowsep="1" align="left"><emphasis role="bold">\r
68	Version 1.50\r
69	</emphasis></entry>\r
70	<entry rowsep="1" align="left"><emphasis role="bold">\r
71	Version 3.30\r
72	</emphasis></entry>\r
73	<entry rowsep="1" align="left"><emphasis role="bold">\r
74	Version 4.00\r
75	</emphasis></entry>\r
76	<entry rowsep="1" align="left"><emphasis role="bold">\r
77	Version 4.10\r
78	</emphasis></entry>\r
79	</row>\r
80	<row>\r
81	<entry>\r
82	gl_InvocationID\r
83	</entry>\r
84	<entry>\r
85	<emphasis>-</emphasis> <!-- 1.10, OpenGL 2.0 -->\r
86	</entry>\r
87	<entry>\r
88	<emphasis>-</emphasis> <!-- 1.20, OpenGL 2.1 -->\r
89	</entry>\r
90	<entry>\r
91	<emphasis>-</emphasis> <!-- 1.30, OpenGL 3.0 -->\r
92	</entry>\r
93	<entry>\r
94	<emphasis>-</emphasis> <!-- 1.40, OpenGL 3.1 -->\r
95	</entry>\r
96	<entry>\r
97	<emphasis>Y</emphasis><superscript>1</superscript> <!-- 1.50, OpenGL 3.2 -->\r
98	</entry>\r
99	<entry>\r
100	<emphasis>Y</emphasis><superscript>1</superscript> <!-- 3.30, OpenGL 3.3 -->\r
101	</entry>\r
102	<entry>\r
103	<emphasis>Y</emphasis> <!-- 4.00, OpenGL 4.0 -->\r
104	</entry>\r
105	<entry>\r
106	<emphasis>Y</emphasis> <!-- 4.10, OpenGL 4.1 -->\r
107	</entry>\r
108	</row>\r
109	</thead>\r
110	</tgroup>\r
111	</informaltable>\r
112	<para>[1] Versions 1.50 to 3.30 - geometry shaders only.</para>\r
113	</refsect1>\r
114	<refsect1 id="seealso"><title>See Also</title>\r
115	<para>\r
116	<citerefentry><refentrytitle>gl_InstanceID</refentrytitle></citerefentry>\r
117	</para>\r
118	</refsect1>\r
119	<refsect1 id="Copyright"><title>Copyright</title>\r
120	<para>\r
121	Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
122	This material may be distributed subject to the terms and conditions set forth in \r
123	the Open Publication License, v 1.0, 8 June 1999.\r
124	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
125	</para>\r
126	</refsect1>\r
127	</refentry>\r