upstream-man-pages/man2/gluOrtho2D.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="gluOrtho2D">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gluOrtho2D</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gluOrtho2D</refname>
  17         <refpurpose>define a 2D orthographic projection matrix</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>gluOrtho2D</function></funcdef>
  23                 <paramdef>GLdouble <parameter>left</parameter></paramdef>
  24                 <paramdef>GLdouble <parameter>right</parameter></paramdef>
  25                 <paramdef>GLdouble <parameter>bottom</parameter></paramdef>
  26                 <paramdef>GLdouble <parameter>top</parameter></paramdef>
  27             </funcprototype>
  28         </funcsynopsis>
  29     </refsynopsisdiv>
  30     <!-- eqn: ignoring delim $$ -->
  31     <refsect1 id="parameters"><title>Parameters</title>
  32         <variablelist>
  33         <varlistentry>
  34             <term><parameter>left</parameter></term>
  35             <term><parameter>right</parameter></term>
  36             <listitem>
  37                 <para>
  38                     Specify the coordinates for the left and right vertical clipping planes.
  39                 </para>
  40             </listitem>
  41         </varlistentry>
  42         <varlistentry>
  43             <term><parameter>bottom</parameter></term>
  44             <term><parameter>top</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specify the coordinates for the bottom and top horizontal clipping planes.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         </variablelist>
  52     </refsect1>
  53     <refsect1 id="description"><title>Description</title>
  54         <para>
  55             <function>gluOrtho2D</function> sets up a two-dimensional orthographic viewing region.
  56             This is equivalent to calling <citerefentry><refentrytitle>glOrtho</refentrytitle></citerefentry> with
  57             <inlineequation><mml:math>
  58                 <!-- eqn: near  =  -1:-->
  59                 <mml:mrow>
  60                     <mml:mi mathvariant="italic">near</mml:mi>
  61                     <mml:mo>=</mml:mo>
  62                     <mml:mn>-1</mml:mn>
  63                 </mml:mrow>
  64             </mml:math></inlineequation>
  65             and
  66             <inlineequation><mml:math>
  67                 <!-- eqn: far  =  1:-->
  68                 <mml:mrow>
  69                     <mml:mi mathvariant="italic">far</mml:mi>
  70                     <mml:mo>=</mml:mo>
  71                     <mml:mn>1</mml:mn>
  72                 </mml:mrow>
  73             </mml:math></inlineequation>.
  74         </para>
  75     </refsect1>
  76     <refsect1 id="seealso"><title>See Also</title>
  77         <para>
  78             <citerefentry><refentrytitle>glOrtho</refentrytitle></citerefentry>,
  79             <citerefentry><refentrytitle>gluPerspective</refentrytitle></citerefentry>
  80         </para>
  81     </refsect1>
  82     <refsect1 id="Copyright"><title>Copyright</title>
  83         <para>
  84             Copyright <trademark class="copyright"></trademark> 1991-2006
  85             Silicon Graphics, Inc. This document is licensed under the SGI
  86             Free Software B License. For details, see
  87             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  88         </para>
  89     </refsect1>
  90 </refentry>