upstream-doc/manglsl/EmitStreamVertex.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="EmitStreamVertex">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>EmitStreamVertex</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>EmitStreamVertex</refname>
  17         <refpurpose>emit a vertex to a specified stream</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>EmitStreamVertex</function></funcdef>
  23                 <paramdef>int <parameter>stream</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>stream</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specifies the stream upon which the vertex will be emitted.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <emphasis>Available only in the Geometry Shader</emphasis>, <function>EmitStreamVertex</function> emits the current
  42             values of output variables to the current output primitive on stream <parameter>stream</parameter>. The argument
  43             <parameter>stream</parameter> must be a constant integral expression. On return from this call, the value of all output variables
  44             for all streams are undefined.
  45         </para>
  46     </refsect1>
  47     <refsect1 id="versions"><title>Version Support</title>
  48         <informaltable frame="topbot">
  49             #VARTABLECOLS#
  50                 <thead>
  51                     #FUNCTABLEHEADER#
  52                     <row>
  53                         <entry>EmitStreamVertex</entry>#newin40#
  54                     </row>
  55                 </thead>
  56             </tgroup>
  57         </informaltable>
  58     </refsect1>
  59     <refsect1 id="seealso"><title>See Also</title>
  60         <para>
  61             <citerefentry><refentrytitle>EmitVertex</refentrytitle></citerefentry>,
  62             <citerefentry><refentrytitle>EndStreamPrimitive</refentrytitle></citerefentry>,
  63             <citerefentry><refentrytitle>EndPrimitive</refentrytitle></citerefentry>
  64         </para>
  65     </refsect1>
  66     <refsect1 id="Copyright"><title>Copyright</title>
  67         <para>
  68             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  69             This material may be distributed subject to the terms and conditions set forth in
  70             the Open Publication License, v 1.0, 8 June 1999.
  71             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  72         </para>
  73     </refsect1>
  74 </refentry>