437 lines
22 KiB
XML
437 lines
22 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
<refentry id="glLoadMatrix">
|
|
<refmeta>
|
|
<refmetainfo>
|
|
<copyright>
|
|
<year>1991-2006</year>
|
|
<holder>Silicon Graphics, Inc.</holder>
|
|
</copyright>
|
|
</refmetainfo>
|
|
<refentrytitle>glLoadMatrix</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glLoadMatrix</refname>
|
|
<refpurpose>replace the current matrix with the specified matrix</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glLoadMatrixd</function></funcdef>
|
|
<paramdef>const GLdouble * <parameter>m</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glLoadMatrixf</function></funcdef>
|
|
<paramdef>const GLfloat * <parameter>m</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<!-- eqn: ignoring delim $$ -->
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>m</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies a pointer to 16 consecutive values, which are used as the
|
|
elements of a
|
|
<inlineequation><mml:math>
|
|
<!-- eqn: 4 times 4:-->
|
|
<mml:mrow>
|
|
<mml:mn>4</mml:mn>
|
|
<mml:mo>×</mml:mo>
|
|
<mml:mn>4</mml:mn>
|
|
</mml:mrow>
|
|
</mml:math></inlineequation>
|
|
column-major matrix.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glLoadMatrix</function> replaces the current matrix with the one whose elements are specified by
|
|
<parameter>m</parameter>.
|
|
The current matrix is the projection matrix,
|
|
modelview matrix,
|
|
or texture matrix,
|
|
depending on the current matrix mode
|
|
(see <citerefentry><refentrytitle>glMatrixMode</refentrytitle></citerefentry>).
|
|
</para>
|
|
<para>
|
|
The current matrix, M, defines a transformation of coordinates.
|
|
For instance, assume M refers to the modelview matrix.
|
|
If
|
|
<inlineequation><mml:math>
|
|
<!-- eqn: v = (v[0], v[1], v[2], v[3]):-->
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>=</mml:mo>
|
|
<mml:mfenced open="(" close=")">
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>0</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>1</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>2</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>3</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:math></inlineequation>
|
|
is the set of object coordinates
|
|
of a vertex,
|
|
and <parameter>m</parameter> points to an array of
|
|
<inlineequation><mml:math>
|
|
<!-- eqn: 16:-->
|
|
<mml:mn>16</mml:mn>
|
|
</mml:math></inlineequation>
|
|
single- or double-precision
|
|
floating-point values
|
|
<inlineequation><mml:math>
|
|
<!-- eqn: m = left { m[0], m[1], ..., m[15] right }:-->
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>=</mml:mo>
|
|
<mml:mfenced open="{" close="}">
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>0</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>1</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
<mml:mi mathvariant="italic">...</mml:mi>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>15</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:math></inlineequation>,
|
|
then the modelview transformation
|
|
<inlineequation><mml:math>
|
|
<!-- eqn: M(v):-->
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">M</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="(" close=")">
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:math></inlineequation>
|
|
does the following:
|
|
</para>
|
|
<para>
|
|
<informalequation><mml:math>
|
|
<!-- eqn: M(v) = left ( matrix { ccol { m[0] above m[1] above m[2] above m[3] } ccol { m[4] above m[5] above m[6] above m[7] } ccol { m[8] above m[9] above m[10] above m[11] } ccol { m[12] above m[13] above m[14] above m[15] } } right ) times left ( matrix { ccol { v[0] above v[1] above v[2] above v[3] } } right ):-->
|
|
<mml:mrow>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">M</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="(" close=")">
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
<mml:mo>=</mml:mo>
|
|
<mml:mrow>
|
|
<mml:mfenced open="(" close=")">
|
|
<mml:mtable>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>0</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>4</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>8</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>12</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>1</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>5</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>9</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>13</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>2</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>6</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>10</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>14</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>3</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>7</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>11</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">m</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>15</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
</mml:mtable>
|
|
</mml:mfenced>
|
|
<mml:mo>×</mml:mo>
|
|
<mml:mfenced open="(" close=")">
|
|
<mml:mtable>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>0</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>1</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>2</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
<mml:mtr>
|
|
<mml:mtd>
|
|
<mml:mrow>
|
|
<mml:mi mathvariant="italic">v</mml:mi>
|
|
<mml:mo>⁡</mml:mo>
|
|
<mml:mfenced open="[" close="]">
|
|
<mml:mn>3</mml:mn>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mtd>
|
|
</mml:mtr>
|
|
</mml:mtable>
|
|
</mml:mfenced>
|
|
</mml:mrow>
|
|
</mml:mrow>
|
|
</mml:math></informalequation>
|
|
</para>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
Projection and texture transformations are similarly defined.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="notes"><title>Notes</title>
|
|
<para>
|
|
While the elements of the matrix may be specified with
|
|
single or double precision, the GL implementation may
|
|
store or operate on these values in less than single
|
|
precision.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if <function>glLoadMatrix</function>
|
|
is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry>
|
|
and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MATRIX_MODE</constant>
|
|
</para>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_COLOR_MATRIX</constant>
|
|
</para>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MODELVIEW_MATRIX</constant>
|
|
</para>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PROJECTION_MATRIX</constant>
|
|
</para>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_MATRIX</constant>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glLoadIdentity</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glMatrixMode</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glMultMatrix</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glMultTransposeMatrix</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glPushMatrix</refentrytitle></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 1991-2006
|
|
Silicon Graphics, Inc. This document is licensed under the SGI
|
|
Free Software B License. For details, see
|
|
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|