reference/image/functions/imageaffinematrixconcat.xml
73fae4ee51b644b72028e610abefefced57c18ad
...
...
@@ -1,43 +1,43 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="function.imageaffinematrixconcat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>imageaffinematrixconcat</refname>
7
-
<refpurpose>Concat two matrices (as in doing many ops in one go)</refpurpose>
6
+
<refpurpose>Concatenate two affine transformation matrices</refpurpose>
8
7
</refnamediv>
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
11
<methodsynopsis>
13
-
<type>array</type><methodname>imageaffinematrixconcat</methodname>
14
-
<methodparam><type>array</type><parameter>m1</parameter></methodparam>
15
-
<methodparam><type>array</type><parameter>m2</parameter></methodparam>
12
+
<type class="union"><type>array</type><type>false</type></type><methodname>imageaffinematrixconcat</methodname>
13
+
<methodparam><type>array</type><parameter>matrix1</parameter></methodparam>
14
+
<methodparam><type>array</type><parameter>matrix2</parameter></methodparam>
16
15
</methodsynopsis>
17
16
<para>
18
-

17
+
Returns the concatenation of two affine transformation matrices,
18
+
what is useful if multiple transformations should be applied to the same
19
+
image in one go.
19
20
</para>
20
-

21
-
&warn.undocumented.func;
22
-

23
21
</refsect1>
24
22

25
23
<refsect1 role="parameters">
26
24
&reftitle.parameters;
27
25
<variablelist>
28
26
<varlistentry>
29
-
<term><parameter>m1</parameter></term>
27
+
<term><parameter>matrix1</parameter></term>
30
28
<listitem>
31
29
<para>
32
-
Array with keys 0 to 5.
30
+
An affine transformation matrix (an array with keys
31
+
<literal>0</literal> to <literal>5</literal> and float values).
33
32
</para>
34
33
</listitem>
35
34
</varlistentry>
36
35
<varlistentry>
37
-
<term><parameter>m2</parameter></term>
36
+
<term><parameter>matrix2</parameter></term>
38
37
<listitem>
39
38
<para>
40
-
Array with keys 0 to 5.
39
+
An affine transformation matrix (an array with keys
40
+
<literal>0</literal> to <literal>5</literal> and float values).
41
41
</para>
42
42
</listitem>
43
43
</varlistentry>
...
...
@@ -47,12 +47,54 @@
47
47
<refsect1 role="returnvalues">
48
48
&reftitle.returnvalues;
49
49
<para>
50
-
Array with keys 0 to 5 and float values&return.falseforfailure;.
50
+
An affine transformation matrix (an array with keys
51
+
<literal>0</literal> to <literal>5</literal> and float values)
52
+
&return.falseforfailure;.
51
53
</para>
52
54
</refsect1>
53
55

54
-
</refentry>
56
+
<refsect1 role="examples">
57
+
&reftitle.examples;
58
+
<para>
59
+
<example>
60
+
<title><function>imageaffinematrixconcat</function> example</title>
61
+
<programlisting role="php">
62
+
<![CDATA[
63
+
<?php
64
+
$m1 = imageaffinematrixget(IMG_AFFINE_TRANSLATE, array('x' => 2, 'y' => 3));
65
+
$m2 = imageaffinematrixget(IMG_AFFINE_SCALE, array('x' => 4, 'y' => 5));
66
+
$matrix = imageaffinematrixconcat($m1, $m2);
67
+
print_r($matrix);
68
+
?>
69
+
]]>
70
+
</programlisting>
71
+
&example.outputs;
72
+
<screen>
73
+
<![CDATA[
74
+
Array
75
+
(
76
+
[0] => 4
77
+
[1] => 0
78
+
[2] => 0
79
+
[3] => 5
80
+
[4] => 8
81
+
[5] => 15
82
+
)
83
+
]]>
84
+
</screen>
85
+
</example>
86
+
</para>
87
+
</refsect1>
55
88

89
+
<refsect1 role="seealso">
90
+
&reftitle.seealso;
91
+
<simplelist>
92
+
<member><function>imageaffine</function></member>
93
+
<member><function>imageaffinematrixget</function></member>
94
+
</simplelist>
95
+
</refsect1>
96
+

97
+
</refentry>
56
98
<!-- Keep this comment at the end of the file
57
99
Local variables:
58
100
mode: sgml
59
101