upstream-doc/manglsl/EndPrimitive.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="EndPrimitive">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>EndPrimitive</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>EndPrimitive</refname>
  17         <refpurpose>complete the current output primitive on the first vertex stream</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>EndPrimitive</function></funcdef>
  23                 <paramdef>void</paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="description"><title>Description</title>
  28         <para>
  29             <emphasis>Available only in the Geometry Shader</emphasis>, <function>EndPrimitive</function> completes the
  30             current output primitive on the first (and possibly only) vertex stream and starts a new one.No vertex is emitted.
  31             Calling <function>EndPrimitive</function> is equivalent to calling <citerefentry><refentrytitle>EmitStreamVertex</refentrytitle></citerefentry>
  32             with <parameter>stream</parameter> set to 0.
  33         </para>
  34     </refsect1>
  35     <refsect1 id="versions"><title>Version Support</title>
  36         <informaltable frame="topbot">
  37             #VARTABLECOLS#
  38                 <thead>
  39                     #FUNCTABLEHEADER#
  40                     <row>
  41                         <entry>EndPrimitive</entry>#newin15#
  42                     </row>
  43                 </thead>
  44             </tgroup>
  45         </informaltable>
  46     </refsect1>
  47     <refsect1 id="seealso"><title>See Also</title>
  48         <para>
  49             <citerefentry><refentrytitle>EmitVertex</refentrytitle></citerefentry>,
  50             <citerefentry><refentrytitle>EmitStreamVertex</refentrytitle></citerefentry>,
  51             <citerefentry><refentrytitle>EndStreamPrimitive</refentrytitle></citerefentry>
  52         </para>
  53     </refsect1>
  54     <refsect1 id="Copyright"><title>Copyright</title>
  55         <para>
  56             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  57             This material may be distributed subject to the terms and conditions set forth in
  58             the Open Publication License, v 1.0, 8 June 1999.
  59             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  60         </para>
  61     </refsect1>
  62 </refentry>