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