upstream-man-pages/man2/glFogCoord.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="glFogCoord">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glFogCoord</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glFogCoord</refname>
  17         <refpurpose>set the current fog coordinates</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glFogCoordd</function></funcdef>
  23                 <paramdef>GLdouble <parameter>coord</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26         <funcsynopsis>
  27             <funcprototype>
  28                 <funcdef>void <function>glFogCoordf</function></funcdef>
  29                 <paramdef>GLfloat <parameter>coord</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <refsect1 id="parameters"><title>Parameters</title>
  34         <variablelist>
  35         <varlistentry>
  36             <term><parameter>coord</parameter></term>
  37             <listitem>
  38                 <para>
  39                     Specify the fog distance.
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         </variablelist>
  44     </refsect1>
  45     <refsynopsisdiv><title>C Specification</title>
  46         <funcsynopsis>
  47             <funcprototype>
  48                 <funcdef>void <function>glFogCoorddv</function></funcdef>
  49                 <paramdef>GLdouble * <parameter>coord</parameter></paramdef>
  50             </funcprototype>
  51         </funcsynopsis>
  52         <funcsynopsis>
  53             <funcprototype>
  54                 <funcdef>void <function>glFogCoordfv</function></funcdef>
  55                 <paramdef>GLfloat * <parameter>coord</parameter></paramdef>
  56             </funcprototype>
  57         </funcsynopsis>
  58     </refsynopsisdiv>
  59     <refsect1 id="parameters2"><title>Parameters</title>
  60         <variablelist>
  61         <varlistentry>
  62             <term><parameter>coord</parameter></term>
  63             <listitem>
  64                 <para>
  65                     Specifies a pointer to an array containing a single value representing the
  66                     fog distance.
  67                 </para>
  68             </listitem>
  69         </varlistentry>
  70         </variablelist>
  71     </refsect1>
  72     <refsect1 id="description"><title>Description</title>
  73         <para>
  74             <function>glFogCoord</function> specifies the fog coordinate that is associated with each vertex and
  75             the current raster position.  The value specified is interpolated and used
  76             in computing the fog color (see <citerefentry><refentrytitle>glFog</refentrytitle></citerefentry>).
  77         </para>
  78     </refsect1>
  79     <refsect1 id="notes"><title>Notes</title>
  80         <para>
  81             <function>glFogCoord</function> is available only if the GL version is 1.4 or greater.
  82         </para>
  83         <para>
  84             The current fog coordinate can be updated at any time.  In particular,
  85             <function>glFogCoord</function> can be called between a call to <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
  86             call to <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
  87         </para>
  88     </refsect1>
  89     <refsect1 id="associatedgets"><title>Associated Gets</title>
  90         <para>
  91             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_CURRENT_FOG_COORD</constant>
  92         </para>
  93     </refsect1>
  94     <refsect1 id="seealso"><title>See Also</title>
  95         <para>
  96             <citerefentry><refentrytitle>glFog</refentrytitle></citerefentry>,
  97             <citerefentry><refentrytitle>glFogCoordPointer</refentrytitle></citerefentry>,
  98             <citerefentry><refentrytitle>glVertex</refentrytitle></citerefentry>
  99         </para>
 100     </refsect1>
 101     <refsect1 id="Copyright"><title>Copyright</title>
 102         <para>
 103             Copyright <trademark class="copyright"></trademark> 1991-2006
 104             Silicon Graphics, Inc. This document is licensed under the SGI
 105             Free Software B License. For details, see
 106             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 107         </para>
 108     </refsect1>
 109 </refentry>