php-doc-en/reference/image/functions/imageaffinematrixconcat.xml
Christoph Michael Becker 96caca72c4 Document imageaffinematrix*() and IMG_AFFINE_*
That still needs improvement; especially the structure of an affine
transformation matrix has to be documented, maybe with imageaffine(),
where there are already user notes by abc at ed48 dot com which appear
to be correct.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339317 c90b9560-bf6c-de11-be94-00142212c4b1
2016-06-10 12:16:15 +00:00

121 lines
3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imageaffinematrixconcat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imageaffinematrixconcat</refname>
<refpurpose>Concatenate two affine transformation matrices</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>imageaffinematrixconcat</methodname>
<methodparam><type>array</type><parameter>m1</parameter></methodparam>
<methodparam><type>array</type><parameter>m2</parameter></methodparam>
</methodsynopsis>
<para>
Returns the concatenation of two affine transformation matrices,
what is useful if multiple transformations should be applied to the same
image in one go.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>m1</parameter></term>
<listitem>
<para>
An affine transformation matrix (an array with keys
<literal>0</literal> to <literal>5</literal> and float values).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>m2</parameter></term>
<listitem>
<para>
An affine transformation matrix (an array with keys
<literal>0</literal> to <literal>5</literal> and float values).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An affine transformation matrix (an array with keys
<literal>0</literal> to <literal>5</literal> and float values)
&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imageaffinematrixconcat</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$m1 = imageaffinematrixget(IMG_AFFINE_TRANSLATE, array('x' = 2, 'y' => 3));
$m2 = imageaffinematrixget(IMG_AFFINE_SCALE, array('x' = 4, 'y' => 5));
$matrix = imageaffinematrixconcat($m1, $m2);
print_r($matrix);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
[0] => 4
[1] => 0
[2] => 0
[3] => 5
[4] => 8
[5] => 15
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imageaffine</function></member>
<member><function>imageaffinematrixget</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->