rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / EndStreamPrimitive.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="EndStreamPrimitive">\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>EndStreamPrimitive</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>EndStreamPrimitive</refname>\r
17 <refpurpose>complete the current output primitive on a specified stream</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>Declaration</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>void <function>EndStreamPrimitive</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 current primitive will be ended.\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>EndStreamPrimitive</function> completes the\r
42 current output primitive on stream <parameter>stream</parameter> and starts a new one. The argument to <parameter>stream</parameter>\r
43 must be a constant integral expression. No vertex is emitted.\r
44 </para>\r
45 </refsect1>\r
46 <refsect1 id="versions"><title>Version Support</title>\r
47 <informaltable frame="topbot">\r
48 #VARTABLECOLS#\r
49 <thead>\r
50 #FUNCTABLEHEADER#\r
51 <row>\r
52 <entry>EndStreamPrimitive</entry>#newin40#\r
53 </row>\r
54 </thead>\r
55 </tgroup>\r
56 </informaltable>\r
57 </refsect1>\r
58 <refsect1 id="seealso"><title>See Also</title>\r
59 <para>\r
60 <citerefentry><refentrytitle>EmitVertex</refentrytitle></citerefentry>,\r
61 <citerefentry><refentrytitle>EmitStreamVertex</refentrytitle></citerefentry>,\r
62 <citerefentry><refentrytitle>EndPrimitive</refentrytitle></citerefentry>\r
63 </para>\r
64 </refsect1>\r
65 <refsect1 id="Copyright"><title>Copyright</title>\r
66 <para>\r
67 Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
68 This material may be distributed subject to the terms and conditions set forth in \r
69 the Open Publication License, v 1.0, 8 June 1999.\r
70 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
71 </para>\r
72 </refsect1>\r
73</refentry>\r