upstream-man-pages/man2/gluGetTessProperty.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="gluGetTessProperty">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluGetTessProperty</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluGetTessProperty</refname>
  17         <refpurpose>get a tessellation object property</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>gluGetTessProperty</function></funcdef>
  23                 <paramdef>GLUtesselator* <parameter>tess</parameter></paramdef>
  24                 <paramdef>GLenum <parameter>which</parameter></paramdef>
  25                 <paramdef>GLdouble* <parameter>data</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28     </refsynopsisdiv>
  29     <!-- eqn: ignoring delim $$ -->
  30     <refsect1 id="parameters"><title>Parameters</title>
  31         <variablelist>
  32         <varlistentry>
  33             <term><parameter>tess</parameter></term>
  34             <listitem>
  35                 <para>
  36                     Specifies the tessellation object (created with <citerefentry><refentrytitle>gluNewTess</refentrytitle></citerefentry>).
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         <varlistentry>
  41             <term><parameter>which</parameter></term>
  42             <listitem>
  43                 <para>
  44                     Specifies the property whose value is to be fetched. Valid values are
  45                     <constant>GLU_TESS_WINDING_RULE</constant>,
  46                     <constant>GLU_TESS_BOUNDARY_ONLY</constant>, and
  47                     <constant>GLU_TESS_TOLERANCE</constant>.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         <varlistentry>
  52             <term><parameter>data</parameter></term>
  53             <listitem>
  54                 <para>
  55                     Specifies a pointer to the location into which the value of the
  56                     named property is written.
  57                 </para>
  58             </listitem>
  59         </varlistentry>
  60         </variablelist>
  61     </refsect1>
  62     <refsect1 id="description"><title>Description</title>
  63         <para>
  64             <function>gluGetTessProperty</function> retrieves properties stored in a tessellation object. These
  65             properties affect the way that tessellation objects
  66             are interpreted and rendered. See the
  67             <citerefentry><refentrytitle>gluTessProperty</refentrytitle></citerefentry> reference page for information about the
  68             properties and what they do.
  69         </para>
  70     </refsect1>
  71     <refsect1 id="seealso"><title>See Also</title>
  72         <para>
  73             <citerefentry><refentrytitle>gluNewTess</refentrytitle></citerefentry>,
  74             <citerefentry><refentrytitle>gluTessProperty</refentrytitle></citerefentry>
  75         </para>
  76     </refsect1>
  77     <refsect1 id="Copyright"><title>Copyright</title>
  78         <para>
  79             Copyright <trademark class="copyright"></trademark> 1991-2006
  80             Silicon Graphics, Inc. This document is licensed under the SGI
  81             Free Software B License. For details, see
  82             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  83         </para>
  84     </refsect1>
  85 </refentry>