upstream-man-pages/manglsl/gl_PrimitiveIDIn.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="gl_PrimitiveIDIn">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gl_PrimitiveIDIn</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gl_PrimitiveIDIn</refname>
  17         <refpurpose>contains the index of the current primitive</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <function>in int gl_PrimitiveIDIn;</function>
  22         </funcsynopsis>
  23     </refsynopsisdiv>
  24     <refsect1 id="description"><title>Description</title>
  25         <para>
  26             <function>gl_PrimitiveIDIn</function> is a geometry language input variable that holds
  27             the number of primitives processed by the shader since the current set of rendering
  28             primitives was started. The first primitive processed by the drawing command is numbered
  29             zero and the primitive ID counter is incremented after every individual point, line
  30             or triangle primitive is processed. For triangles drawn in point or line mode, the
  31             primitive ID counter is incremented only once, even through multiple points or lines
  32             may actually be drawn. Restarting a primitive topology using the primitive restart
  33             index has no effect on the primitive ID counter.
  34         </para>
  35     </refsect1>
  36     <refsect1 id="versions"><title>Version Support</title>
  37         <informaltable frame="topbot">
  38             <tgroup cols="3" align="left">
  39                 <colspec colwidth="1.1*" />
  40                 <colspec colwidth="1*" align="center" />
  41                 <colspec colwidth="1*" align="center" />
  42                 <colspec colwidth="1*" align="center" />
  43                 <colspec colwidth="1*" align="center" />
  44                 <colspec colwidth="1*" align="center" />
  45                 <colspec colwidth="1*" align="center" />
  46                 <colspec colwidth="1*" align="center" />
  47                 <colspec colwidth="1*" align="center" />
  48                 <thead>
  49                     <row>
  50                         <entry rowsep="1" align="left"><emphasis role="bold">
  51                         Variable
  52                         </emphasis></entry>
  53                         <entry rowsep="1" align="left"><emphasis role="bold">
  54                         Version 1.10
  55                         </emphasis></entry>
  56                         <entry rowsep="1" align="left"><emphasis role="bold">
  57                         Version 1.20
  58                         </emphasis></entry>
  59                         <entry rowsep="1" align="left"><emphasis role="bold">
  60                         Version 1.30
  61                         </emphasis></entry>
  62                         <entry rowsep="1" align="left"><emphasis role="bold">
  63                         Version 1.40
  64                         </emphasis></entry>
  65                         <entry rowsep="1" align="left"><emphasis role="bold">
  66                         Version 1.50
  67                         </emphasis></entry>
  68                         <entry rowsep="1" align="left"><emphasis role="bold">
  69                         Version 3.30
  70                         </emphasis></entry>
  71                         <entry rowsep="1" align="left"><emphasis role="bold">
  72                         Version 4.00
  73                         </emphasis></entry>
  74                         <entry rowsep="1" align="left"><emphasis role="bold">
  75                         Version 4.10
  76                         </emphasis></entry>
  77                     </row>
  78                     <row>
  79                         <entry>
  80                             gl_PrimitiveIDIn
  81                         </entry>
  82                         <entry>
  83                             <emphasis>-</emphasis>  <!-- 1.10, OpenGL 2.0 -->
  84                         </entry>
  85                         <entry>
  86                             <emphasis>-</emphasis>  <!-- 1.20, OpenGL 2.1 -->
  87                         </entry>
  88                         <entry>
  89                             <emphasis>-</emphasis>  <!-- 1.30, OpenGL 3.0 -->
  90                         </entry>
  91                         <entry>
  92                             <emphasis>-</emphasis>  <!-- 1.40, OpenGL 3.1 -->
  93                         </entry>
  94                         <entry>
  95                             <emphasis>Y</emphasis>  <!-- 1.50, OpenGL 3.2 -->
  96                         </entry>
  97                         <entry>
  98                             <emphasis>Y</emphasis>  <!-- 3.30, OpenGL 3.3 -->
  99                         </entry>
 100                         <entry>
 101                             <emphasis>Y</emphasis>  <!-- 4.00, OpenGL 4.0 -->
 102                         </entry>
 103                         <entry>
 104                             <emphasis>Y</emphasis>  <!-- 4.10, OpenGL 4.1 -->
 105                         </entry>
 106                     </row>
 107                 </thead>
 108             </tgroup>
 109         </informaltable>
 110     </refsect1>
 111     <refsect1 id="seealso"><title>See Also</title>
 112         <para>
 113             <citerefentry><refentrytitle>gl_InstanceID</refentrytitle></citerefentry>
 114         </para>
 115     </refsect1>
 116     <refsect1 id="Copyright"><title>Copyright</title>
 117         <para>
 118             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 119             This material may be distributed subject to the terms and conditions set forth in
 120             the Open Publication License, v 1.0, 8 June 1999.
 121             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 122         </para>
 123     </refsect1>
 124 </refentry>