upstream-man-pages/man2/xhtml/glTranslate.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glTranslate</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glTranslate"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glTranslate — multiply the current matrix by a translation matrix</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glTranslated</b>(</code></td><td>GLdouble  </td><td><var class="pdparam">x</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">y</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">z</var><code>)</code>;</td></tr></table></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glTranslatef</b>(</code></td><td>GLfloat  </td><td><var class="pdparam">x</var>, </td></tr><tr><td> </td><td>GLfloat  </td><td><var class="pdparam">y</var>, </td></tr><tr><td> </td><td>GLfloat  </td><td><var class="pdparam">z</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>x</code></em>, </span><span class="term"><em class="parameter"><code>y</code></em>, </span><span class="term"><em class="parameter"><code>z</code></em></span></dt><dd><p>
   4                     Specify the <span class="emphasis"><em>x</em></span>, <span class="emphasis"><em>y</em></span>, and <span class="emphasis"><em>z</em></span> coordinates of a translation vector.
   5                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   6             <code class="function">glTranslate</code> produces a translation by
   7             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
   8
   9                 <mml:mfenced open="(" close=")">
  10                     <mml:mi mathvariant="italic">x</mml:mi>
  11                     <mml:mi mathvariant="italic">y</mml:mi>
  12                     <mml:mi mathvariant="italic">z</mml:mi>
  13                 </mml:mfenced>
  14             </mml:math>.
  15             The current matrix
  16             (see
  17             <a class="citerefentry" href="glMatrixMode.xml"><span class="citerefentry"><span class="refentrytitle">glMatrixMode</span></span></a>)
  18             is multiplied by this translation matrix,
  19             with the product replacing the current matrix, as if
  20             <a class="citerefentry" href="glMultMatrix.xml"><span class="citerefentry"><span class="refentrytitle">glMultMatrix</span></span></a> were called with the following matrix
  21             for its argument:
  22         </p><p>
  23             </p><div class="informalequation"><mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  24
  25                 <mml:mfenced open="(" close=")">
  26                     <mml:mtable>
  27                         <mml:mtr>
  28                             <mml:mtd>
  29                                 <mml:mn>1</mml:mn>
  30                             </mml:mtd>
  31                             <mml:mtd>
  32                                 <mml:mn>0</mml:mn>
  33                             </mml:mtd>
  34                             <mml:mtd>
  35                                 <mml:mn>0</mml:mn>
  36                             </mml:mtd>
  37                             <mml:mtd>
  38                                 <mml:mi mathvariant="italic">x</mml:mi>
  39                             </mml:mtd>
  40                         </mml:mtr>
  41                         <mml:mtr>
  42                             <mml:mtd>
  43                                 <mml:mn>0</mml:mn>
  44                             </mml:mtd>
  45                             <mml:mtd>
  46                                 <mml:mn>1</mml:mn>
  47                             </mml:mtd>
  48                             <mml:mtd>
  49                                 <mml:mn>0</mml:mn>
  50                             </mml:mtd>
  51                             <mml:mtd>
  52                                 <mml:mi mathvariant="italic">y</mml:mi>
  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>0</mml:mn>
  61                             </mml:mtd>
  62                             <mml:mtd>
  63                                 <mml:mn>1</mml:mn>
  64                             </mml:mtd>
  65                             <mml:mtd>
  66                                 <mml:mi mathvariant="italic">z</mml:mi>
  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>0</mml:mn>
  78                             </mml:mtd>
  79                             <mml:mtd>
  80                                 <mml:mn>1</mml:mn>
  81                             </mml:mtd>
  82                         </mml:mtr>
  83                     </mml:mtable>
  84                 </mml:mfenced>
  85             </mml:math></div><p>
  86         </p><p>
  87         </p><p>
  88             If the matrix mode is either <code class="constant">GL_MODELVIEW</code> or <code class="constant">GL_PROJECTION</code>,
  89             all objects drawn after a call to <code class="function">glTranslate</code> are translated.
  90         </p><p>
  91             Use <a class="citerefentry" href="glPushMatrix.xml"><span class="citerefentry"><span class="refentrytitle">glPushMatrix</span></span></a> and
  92             <a class="citerefentry" href="glPopMatrix.xml"><span class="citerefentry"><span class="refentrytitle">glPopMatrix</span></span></a> to save and restore
  93             the untranslated coordinate system.
  94         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  95             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glTranslate</code>
  96             is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>
  97             and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  98         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  99             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MATRIX_MODE</code>
 100         </p><p>
 101             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_COLOR_MATRIX</code>
 102         </p><p>
 103             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MODELVIEW_MATRIX</code>
 104         </p><p>
 105             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PROJECTION_MATRIX</code>
 106         </p><p>
 107             <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_TEXTURE_MATRIX</code>
 108         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
 109             <a class="citerefentry" href="glMatrixMode.xml"><span class="citerefentry"><span class="refentrytitle">glMatrixMode</span></span></a>,
 110             <a class="citerefentry" href="glMultMatrix.xml"><span class="citerefentry"><span class="refentrytitle">glMultMatrix</span></span></a>,
 111             <a class="citerefentry" href="glPushMatrix.xml"><span class="citerefentry"><span class="refentrytitle">glPushMatrix</span></span></a>,
 112             <a class="citerefentry" href="glRotate.xml"><span class="citerefentry"><span class="refentrytitle">glRotate</span></span></a>,
 113             <a class="citerefentry" href="glScale.xml"><span class="citerefentry"><span class="refentrytitle">glScale</span></span></a>
 114         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
 115             Copyright <span class="trademark"></span>© 1991-2006
 116             Silicon Graphics, Inc. This document is licensed under the SGI
 117             Free Software B License. For details, see
 118             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
 119         </p></div></div></body></html>