From 8e5ac3ea6eaa8b7dd24523003057e5fa8f564c20 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Wed, 15 May 2013 20:12:58 +0000
Subject: [PATCH] Add PHP 5.5 image functions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330230 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/image/functions/imageaffine.xml     | 77 ++++++++++++++++
 .../functions/imageaffinematrixconcat.xml     | 75 ++++++++++++++++
 .../image/functions/imageaffinematrixget.xml  | 76 ++++++++++++++++
 reference/image/functions/imagecrop.xml       | 68 ++++++++++++++
 reference/image/functions/imagecropauto.xml   | 86 ++++++++++++++++++
 reference/image/functions/imagescale.xml      | 90 +++++++++++++++++++
 6 files changed, 472 insertions(+)
 create mode 100644 reference/image/functions/imageaffine.xml
 create mode 100644 reference/image/functions/imageaffinematrixconcat.xml
 create mode 100644 reference/image/functions/imageaffinematrixget.xml
 create mode 100644 reference/image/functions/imagecrop.xml
 create mode 100644 reference/image/functions/imagecropauto.xml
 create mode 100644 reference/image/functions/imagescale.xml

diff --git a/reference/image/functions/imageaffine.xml b/reference/image/functions/imageaffine.xml
new file mode 100644
index 0000000000..eea510a05b
--- /dev/null
+++ b/reference/image/functions/imageaffine.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.imageaffine" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>imageaffine</refname>
+  <refpurpose>Return an image containing the affine tramsformed src image, using an optional clipping area</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>resource</type><methodname>imageaffine</methodname>
+   <methodparam><type>resource</type><parameter>image</parameter></methodparam>
+   <methodparam><type>array</type><parameter>affine</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>clip</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   &gd.image.description;
+   <varlistentry>
+    <term><parameter>affine</parameter></term>
+    <listitem>
+     <para>
+      Array with keys 0 to 5.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>clip</parameter></term>
+    <listitem>
+     <para>
+      Array with keys "x", "y", "width" and "height".
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return affined image resource on success&return.falseforfailure;.
+  </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
+-->
diff --git a/reference/image/functions/imageaffinematrixconcat.xml b/reference/image/functions/imageaffinematrixconcat.xml
new file mode 100644
index 0000000000..b47a237552
--- /dev/null
+++ b/reference/image/functions/imageaffinematrixconcat.xml
@@ -0,0 +1,75 @@
+<?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>Concat two matrices (as in doing many ops in one go)</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>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>m1</parameter></term>
+    <listitem>
+     <para>
+      Array with keys 0 to 5.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>m2</parameter></term>
+    <listitem>
+     <para>
+      Array with keys 0 to 5.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Array with keys 0 to 5 and float values&return.falseforfailure;.
+  </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
+-->
diff --git a/reference/image/functions/imageaffinematrixget.xml b/reference/image/functions/imageaffinematrixget.xml
new file mode 100644
index 0000000000..98e9e74766
--- /dev/null
+++ b/reference/image/functions/imageaffinematrixget.xml
@@ -0,0 +1,76 @@
+<?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>Return an image containing the affine tramsformed src image, using an optional clipping area</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>array</type><methodname>imageaffinematrixget</methodname>
+   <methodparam><type>int</type><parameter>type</parameter></methodparam>
+   <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>type</parameter></term>
+    <listitem>
+     <para>
+      One of <constant>IMG_AFFINE_*</constant> constants.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>options</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Array with keys 0 to 5 and float values&return.falseforfailure;.
+  </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
+-->
diff --git a/reference/image/functions/imagecrop.xml b/reference/image/functions/imagecrop.xml
new file mode 100644
index 0000000000..ba1734bd6f
--- /dev/null
+++ b/reference/image/functions/imagecrop.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.imagecrop" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>imagecrop</refname>
+  <refpurpose>Crop an image using the given coordinates and size, x, y, width and height</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>resource</type><methodname>imagecrop</methodname>
+   <methodparam><type>resource</type><parameter>image</parameter></methodparam>
+   <methodparam><type>array</type><parameter>rect</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   &gd.image.description;
+   <varlistentry>
+    <term><parameter>rect</parameter></term>
+    <listitem>
+     <para>
+      Array with keys "x", "y", "width" and "height".
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return cropped image resource on success&return.falseforfailure;.
+  </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
+-->
diff --git a/reference/image/functions/imagecropauto.xml b/reference/image/functions/imagecropauto.xml
new file mode 100644
index 0000000000..9e9b9b9770
--- /dev/null
+++ b/reference/image/functions/imagecropauto.xml
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.imagecropauto" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>imagecropauto</refname>
+  <refpurpose>Crop an image automatically using one of the available modes</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>resource</type><methodname>imagecropauto</methodname>
+   <methodparam><type>resource</type><parameter>image</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>-1</initializer></methodparam>
+   <methodparam choice="opt"><type>float</type><parameter>threshold</parameter><initializer>.5</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>color</parameter><initializer>-1</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   &gd.image.description;
+   <varlistentry>
+    <term><parameter>mode</parameter></term>
+    <listitem>
+     <para>
+      One of <constant>IMG_CROP_*</constant> constants.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>threshold</parameter></term>
+    <listitem>
+     <para>
+      Used in <constant>IMG_CROP_THRESHOLD</constant> mode.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>color</parameter></term>
+    <listitem>
+     <para>
+      Used in <constant>IMG_CROP_THRESHOLD</constant> mode.
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return cropped image resource on success&return.falseforfailure;.
+  </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
+-->
diff --git a/reference/image/functions/imagescale.xml b/reference/image/functions/imagescale.xml
new file mode 100644
index 0000000000..e889bde8fd
--- /dev/null
+++ b/reference/image/functions/imagescale.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.imagescale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>imagescale</refname>
+  <refpurpose>Scale an image using the given new width and height</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>resource</type><methodname>imagescale</methodname>
+   <methodparam><type>resource</type><parameter>image</parameter></methodparam>
+   <methodparam><type>int</type><parameter>new_width</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>new_height</parameter><initializer>-1</initializer></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>IMG_BILINEAR_FIXED</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   &gd.image.description;
+   <varlistentry>
+    <term><parameter>new_width</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>new_height</parameter></term>
+    <listitem>
+     <para>
+      
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>mode</parameter></term>
+    <listitem>
+     <para>
+      One of <constant>IMG_NEAREST_NEIGHBOUR</constant>,
+      <constant>IMG_BILINEAR_FIXED</constant>,
+      <constant>IMG_BICUBIC</constant>,
+      <constant>IMG_BICUBIC_FIXED</constant> or anything else (will use two
+      pass).
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Return scaled image resource on success&return.falseforfailure;.
+  </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
+-->