upstream-man-pages/manglsl/transpose.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="transpose">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>transpose</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>transpose</refname>
  17         <refpurpose>calculate the transpose of a matrix</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>mat2 <function>transpose</function></funcdef>
  23                 <paramdef>mat2 <parameter>m</parameter></paramdef>
  24             </funcprototype>
  25             <funcprototype>
  26                 <funcdef>mat3 <function>transpose</function></funcdef>
  27                 <paramdef>mat3 <parameter>m</parameter></paramdef>
  28             </funcprototype>
  29             <funcprototype>
  30                 <funcdef>mat4 <function>transpose</function></funcdef>
  31                 <paramdef>mat4 <parameter>m</parameter></paramdef>
  32             </funcprototype>
  33             <funcprototype>
  34                 <funcdef>mat2x3 <function>transpose</function></funcdef>
  35                 <paramdef>mat3x2 <parameter>m</parameter></paramdef>
  36             </funcprototype>
  37             <funcprototype>
  38                 <funcdef>mat2x4 <function>transpose</function></funcdef>
  39                 <paramdef>mat4x2 <parameter>m</parameter></paramdef>
  40             </funcprototype>
  41             <funcprototype>
  42                 <funcdef>mat3x2 <function>transpose</function></funcdef>
  43                 <paramdef>mat2x3 <parameter>m</parameter></paramdef>
  44             </funcprototype>
  45             <funcprototype>
  46                 <funcdef>mat3x4 <function>transpose</function></funcdef>
  47                 <paramdef>mat4x3 <parameter>m</parameter></paramdef>
  48             </funcprototype>
  49             <funcprototype>
  50                 <funcdef>mat4x2 <function>transpose</function></funcdef>
  51                 <paramdef>mat2x4 <parameter>m</parameter></paramdef>
  52             </funcprototype>
  53             <funcprototype>
  54                 <funcdef>mat4x3 <function>transpose</function></funcdef>
  55                 <paramdef>mat3x4 <parameter>m</parameter></paramdef>
  56             </funcprototype>
  57             <funcprototype>
  58                 <funcdef>dmat2 <function>transpose</function></funcdef>
  59                 <paramdef>dmat2 <parameter>m</parameter></paramdef>
  60             </funcprototype>
  61             <funcprototype>
  62                 <funcdef>dmat3 <function>transpose</function></funcdef>
  63                 <paramdef>dmat3 <parameter>m</parameter></paramdef>
  64             </funcprototype>
  65             <funcprototype>
  66                 <funcdef>dmat4 <function>transpose</function></funcdef>
  67                 <paramdef>dmat4 <parameter>m</parameter></paramdef>
  68             </funcprototype>
  69             <funcprototype>
  70                 <funcdef>dmat2x3 <function>transpose</function></funcdef>
  71                 <paramdef>dmat3x2 <parameter>m</parameter></paramdef>
  72             </funcprototype>
  73             <funcprototype>
  74                 <funcdef>dmat2x4 <function>transpose</function></funcdef>
  75                 <paramdef>dmat4x2 <parameter>m</parameter></paramdef>
  76             </funcprototype>
  77             <funcprototype>
  78                 <funcdef>dmat3x2 <function>transpose</function></funcdef>
  79                 <paramdef>dmat2x3 <parameter>m</parameter></paramdef>
  80             </funcprototype>
  81             <funcprototype>
  82                 <funcdef>dmat3x4 <function>transpose</function></funcdef>
  83                 <paramdef>dmat4x3 <parameter>m</parameter></paramdef>
  84             </funcprototype>
  85             <funcprototype>
  86                 <funcdef>dmat4x2 <function>transpose</function></funcdef>
  87                 <paramdef>dmat2x4 <parameter>m</parameter></paramdef>
  88             </funcprototype>
  89             <funcprototype>
  90                 <funcdef>dmat4x3 <function>transpose</function></funcdef>
  91                 <paramdef>dmat3x4 <parameter>m</parameter></paramdef>
  92             </funcprototype>
  93         </funcsynopsis>
  94     </refsynopsisdiv>
  95     <refsect1 id="parameters"><title>Parameters</title>
  96         <variablelist>
  97         <varlistentry>
  98             <term><parameter>m</parameter></term>
  99             <listitem>
 100                 <para>
 101                     Specifies the matrix of which to take the transpose.
 102                 </para>
 103             </listitem>
 104         </varlistentry>
 105         </variablelist>
 106     </refsect1>
 107     <refsect1 id="description"><title>Description</title>
 108         <para>
 109             <function>transpose</function> returns the transpose of the matrix <parameter>m</parameter>.
 110         </para>
 111     </refsect1>
 112     <refsect1 id="versions"><title>Version Support</title>
 113         <informaltable frame="topbot">
 114             #VARTABLECOLS#
 115                 <thead>
 116                     #FUNCTABLEHEADER#
 117                     <row>
 118                         <entry>transpose (float)</entry>#newin12#
 119                     </row>
 120                     <row>
 121                         <entry>transpose (double)</entry>#newin40#
 122                     </row>
 123                 </thead>
 124             </tgroup>
 125         </informaltable>
 126     </refsect1>
 127     <refsect1 id="seealso"><title>See Also</title>
 128         <para>
 129             <citerefentry><refentrytitle>determinant</refentrytitle></citerefentry>,
 130             <citerefentry><refentrytitle>inverse</refentrytitle></citerefentry>
 131         </para>
 132     </refsect1>
 133     <refsect1 id="Copyright"><title>Copyright</title>
 134         <para>
 135             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 136             This material may be distributed subject to the terms and conditions set forth in
 137             the Open Publication License, v 1.0, 8 June 1999.
 138             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 139         </para>
 140     </refsect1>
 141 </refentry>