upstream-doc/man2/gluTessBeginContour.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="gluTessBeginContour">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluTessBeginContour</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluTessBeginContour</refname>
  17         <refpurpose>delimit a contour description</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>gluTessBeginContour</function></funcdef>
  23                 <paramdef>GLUtesselator* <parameter>tess</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsynopsisdiv><title>C Specification</title>
  28         <funcsynopsis>
  29             <funcprototype>
  30                 <funcdef>void <function>gluTessEndContour</function></funcdef>
  31                 <paramdef>GLUtesselator* <parameter>tess</parameter></paramdef>
  32             </funcprototype>
  33         </funcsynopsis>
  34     </refsynopsisdiv>
  35     <!-- eqn: ignoring delim $$ -->
  36     <refsect1 id="parameters"><title>Parameters</title>
  37         <variablelist>
  38         <varlistentry>
  39             <term><parameter>tess</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies the tessellation object (created with <citerefentry><refentrytitle>gluNewTess</refentrytitle></citerefentry>).
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         </variablelist>
  47     </refsect1>
  48     <refsect1 id="description"><title>Description</title>
  49         <para>
  50             <function>gluTessBeginContour</function> and <citerefentry><refentrytitle>gluTessEndContour</refentrytitle></citerefentry> delimit the definition of a
  51             polygon contour. Within each <function>gluTessBeginContour</function>/<citerefentry><refentrytitle>gluTessEndContour</refentrytitle></citerefentry>
  52             pair, there can be zero or more calls to <citerefentry><refentrytitle>gluTessVertex</refentrytitle></citerefentry>. The vertices
  53             specify a closed contour (the last vertex of each contour is automatically linked
  54             to the first).  See the <citerefentry><refentrytitle>gluTessVertex</refentrytitle></citerefentry> reference page for more details.
  55             <function>gluTessBeginContour</function> can only be called between <citerefentry><refentrytitle>gluTessBeginPolygon</refentrytitle></citerefentry> and <citerefentry><refentrytitle>gluTessEndPolygon</refentrytitle></citerefentry>.
  56         </para>
  57     </refsect1>
  58     <refsect1 id="seealso"><title>See Also</title>
  59         <para>
  60             <citerefentry><refentrytitle>gluNewTess</refentrytitle></citerefentry>,
  61             <citerefentry><refentrytitle>gluTessBeginPolygon</refentrytitle></citerefentry>,
  62             <citerefentry><refentrytitle>gluTessCallback</refentrytitle></citerefentry>,
  63             <citerefentry><refentrytitle>gluTessEndPolygon</refentrytitle></citerefentry>,
  64             <citerefentry><refentrytitle>gluTessNormal</refentrytitle></citerefentry>,
  65             <citerefentry><refentrytitle>gluTessProperty</refentrytitle></citerefentry>,
  66             <citerefentry><refentrytitle>gluTessVertex</refentrytitle></citerefentry>
  67         </para>
  68     </refsect1>
  69     <refsect1 id="Copyright"><title>Copyright</title>
  70         <para>
  71             Copyright <trademark class="copyright"></trademark> 1991-2006
  72             Silicon Graphics, Inc. This document is licensed under the SGI
  73             Free Software B License. For details, see
  74             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  75         </para>
  76     </refsect1>
  77 </refentry>