upstream-man-pages/man2/glLoadIdentity.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="glLoadIdentity">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glLoadIdentity</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glLoadIdentity</refname>
  17         <refpurpose>replace the current matrix with the identity matrix</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glLoadIdentity</function></funcdef>
  23                 <paramdef> <parameter>void</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="description"><title>Description</title>
  28         <para>
  29             <function>glLoadIdentity</function> replaces the current matrix with the identity matrix.
  30             It is semantically equivalent to calling <citerefentry><refentrytitle>glLoadMatrix</refentrytitle></citerefentry>
  31             with the identity matrix
  32         </para>
  33         <para>
  34         </para>
  35         <para>
  36             <informalequation><mml:math>
  37                 <!-- eqn: left (  {   matrix {    lcol { 1 above 0 above 0 above 0  }    lcol { 0 above 1 above 0 above 0  }    lcol { 0 above 0 above 1 above 0  }    lcol { 0 above 0 above 0 above 1 } } }    right ):-->
  38                 <mml:mfenced open="(" close=")">
  39                     <mml:mfenced open="" close="">
  40                         <mml:mtable>
  41                             <mml:mtr>
  42                                 <mml:mtd>
  43                                     <mml:mn>1</mml:mn>
  44                                 </mml:mtd>
  45                                 <mml:mtd>
  46                                     <mml:mn>0</mml:mn>
  47                                 </mml:mtd>
  48                                 <mml:mtd>
  49                                     <mml:mn>0</mml:mn>
  50                                 </mml:mtd>
  51                                 <mml:mtd>
  52                                     <mml:mn>0</mml:mn>
  53                                 </mml:mtd>
  54                             </mml:mtr>
  55                             <mml:mtr>
  56                                 <mml:mtd>
  57                                     <mml:mn>0</mml:mn>
  58                                 </mml:mtd>
  59                                 <mml:mtd>
  60                                     <mml:mn>1</mml:mn>
  61                                 </mml:mtd>
  62                                 <mml:mtd>
  63                                     <mml:mn>0</mml:mn>
  64                                 </mml:mtd>
  65                                 <mml:mtd>
  66                                     <mml:mn>0</mml:mn>
  67                                 </mml:mtd>
  68                             </mml:mtr>
  69                             <mml:mtr>
  70                                 <mml:mtd>
  71                                     <mml:mn>0</mml:mn>
  72                                 </mml:mtd>
  73                                 <mml:mtd>
  74                                     <mml:mn>0</mml:mn>
  75                                 </mml:mtd>
  76                                 <mml:mtd>
  77                                     <mml:mn>1</mml:mn>
  78                                 </mml:mtd>
  79                                 <mml:mtd>
  80                                     <mml:mn>0</mml:mn>
  81                                 </mml:mtd>
  82                             </mml:mtr>
  83                             <mml:mtr>
  84                                 <mml:mtd>
  85                                     <mml:mn>0</mml:mn>
  86                                 </mml:mtd>
  87                                 <mml:mtd>
  88                                     <mml:mn>0</mml:mn>
  89                                 </mml:mtd>
  90                                 <mml:mtd>
  91                                     <mml:mn>0</mml:mn>
  92                                 </mml:mtd>
  93                                 <mml:mtd>
  94                                     <mml:mn>1</mml:mn>
  95                                 </mml:mtd>
  96                             </mml:mtr>
  97                         </mml:mtable>
  98                     </mml:mfenced>
  99                 </mml:mfenced>
 100             </mml:math></informalequation>
 101         </para>
 102         <para>
 103         </para>
 104         <para>
 105             but in some cases it is more efficient.
 106         </para>
 107     </refsect1>
 108     <refsect1 id="errors"><title>Errors</title>
 109         <para>
 110             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glLoadIdentity</function>
 111             is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
 112             and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
 113         </para>
 114     </refsect1>
 115     <refsect1 id="associatedgets"><title>Associated Gets</title>
 116         <para>
 117             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MATRIX_MODE</constant>
 118         </para>
 119         <para>
 120             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_COLOR_MATRIX</constant>
 121         </para>
 122         <para>
 123             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MODELVIEW_MATRIX</constant>
 124         </para>
 125         <para>
 126             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PROJECTION_MATRIX</constant>
 127         </para>
 128         <para>
 129             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_MATRIX</constant>
 130         </para>
 131     </refsect1>
 132     <refsect1 id="seealso"><title>See Also</title>
 133         <para>
 134             <citerefentry><refentrytitle>glLoadMatrix</refentrytitle></citerefentry>,
 135             <citerefentry><refentrytitle>glLoadTransposeMatrix</refentrytitle></citerefentry>,
 136             <citerefentry><refentrytitle>glMatrixMode</refentrytitle></citerefentry>,
 137             <citerefentry><refentrytitle>glMultMatrix</refentrytitle></citerefentry>,
 138             <citerefentry><refentrytitle>glMultTransposeMatrix</refentrytitle></citerefentry>,
 139             <citerefentry><refentrytitle>glPushMatrix</refentrytitle></citerefentry>
 140         </para>
 141     </refsect1>
 142     <refsect1 id="Copyright"><title>Copyright</title>
 143         <para>
 144             Copyright <trademark class="copyright"></trademark> 1991-2006
 145             Silicon Graphics, Inc. This document is licensed under the SGI
 146             Free Software B License. For details, see
 147             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 148         </para>
 149     </refsect1>
 150 </refentry>