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