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