<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imageaffinematrixget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imageaffinematrixget</refname>
  <refpurpose>Get an affine transformation matrix</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>imageaffinematrixget</methodname>
   <methodparam><type>int</type><parameter>type</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>float</type></type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns an affine transformation matrix.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>type</parameter></term>
    <listitem>
     <para>
      One of the <constant>IMG_AFFINE_*</constant> constants.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      If <parameter>type</parameter> is <constant>IMG_AFFINE_TRANSLATE</constant>
      or <constant>IMG_AFFINE_SCALE</constant>,
      <parameter>options</parameter> has to be an <type>array</type> with keys <literal>x</literal>
      and <literal>y</literal>, both having <type>float</type> values.
     </para>
     <para>
      If <parameter>type</parameter> is <constant>IMG_AFFINE_ROTATE</constant>,
      <constant>IMG_AFFINE_SHEAR_HORIZONTAL</constant> or <constant>IMG_AFFINE_SHEAR_VERTICAL</constant>,
      <parameter>options</parameter> has to be a <type>float</type> specifying the angle.
     </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>imageaffinematrixget</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$matrix = imageaffinematrixget(IMG_AFFINE_TRANSLATE, array('x' => 2, 'y' => 3));
print_r($matrix);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [0] => 1
    [1] => 0
    [2] => 0
    [3] => 1
    [4] => 2
    [5] => 3
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>imageaffine</function></member>
   <member><function>imageaffinematrixconcat</function></member>
  </simplelist>
 </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
-->
