cvs: peardoc /en/pecl imagick.xml

chregu Wed Jan 16 17:24:03 2002 EDT Modified files: /peardoc/en/pecl imagick.xml Log: Documentation for 0.1

Index: peardoc/en/pecl/imagick.xml diff -u peardoc/en/pecl/imagick.xml:1.3 peardoc/en/pecl/imagick.xml:1.4 --- peardoc/en/pecl/imagick.xml:1.3 Mon Dec 17 13:42:12 2001 +++ peardoc/en/pecl/imagick.xml Wed Jan 16 17:24:02 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <reference id="packages.imagick"> <title>Imagick</title> <titleabbrev>imagick</titleabbrev> @@ -36,12 +36,12 @@ <para> short installation note: <itemizedlist> - <listitem><simpara>You need at least PHP 4.1 (or some of the RCs).</simpara></listitem> + <listitem><simpara>You need at least PHP 4.1.</simpara></listitem> <listitem> <simpara> untar the imagick.tgz archive into php4/ext (Latest official release is <ulink - url="http://php.chregu.tv/pear/pecl_imagick-0.0.2a.tgz">0.0.2a</ulink>, + url="http://php.chregu.tv/pear/pecl_imagick-0.1.tgz">0.1</ulink>, or try the <ulink url="http://php.chregu.tv/pear/imagick-cvs.tgz">cvs-snapshot </ulink>) @@ -50,7 +50,7 @@ <listitem> <simpara> If the new directory is now called something like - pecl_image-0.0.x, then you should rename it to imagick (except you + pecl_image-0.x, then you should rename it to imagick (except you only want to build it as self-contained php-module) </simpara> </listitem> @@ -475,18 +475,18 @@ </refsect1> </refentry> - <refentry id="function.imagick-crop"> + <refentry id="function.imagick-copy-crop"> <refnamediv> - <refname>imagick_crop</refname> + <refname>imagick_copy_crop</refname> <refpurpose> - Crops an image + Crops an image and returns a new handle </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>imagick_crop</function></funcdef> + <funcdef>resource <function>imagick_copy_crop</function></funcdef> <paramdef>resource <parameter>imagick_handle</parameter></paramdef> <paramdef>int <parameter>width</parameter></paramdef> <paramdef>int <parameter>height</parameter></paramdef> @@ -496,24 +496,25 @@ </funcsynopsis> &warn.experimental.func; <para> - Returns: &true; on success, &false; + Returns: a new handle on success, &false; on error. </para> + <note><para>This function was added in version 0.1</para></note> </refsect1> </refentry> - <refentry id="function.imagick-sample"> + <refentry id="function.imagick-copy-sample"> <refnamediv> - <refname>imagick_sample</refname> + <refname>imagick_copy_sample</refname> <refpurpose> - Scales an image to the desired dimensions with pixelsampling. + Scales an image to the desired dimensions with pixelsampling and returns a new handle. </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>imagick_sample</function></funcdef> + <funcdef>resource <function>imagick_copy_sample</function></funcdef> <paramdef>resource <parameter>imagick_handle</parameter></paramdef> <paramdef>int <parameter>width</parameter></paramdef> <paramdef>int <parameter>height</parameter></paramdef> @@ -521,7 +522,7 @@ </funcsynopsis> &warn.experimental.func; <para> - Returns: &true; on success, &false; + Returns: a new handle on success, &false; on error. </para> <para> @@ -531,25 +532,25 @@ image. </para> <para> - See also: <function>imagick_resize</function>. + See also: <function>imagick_copy_resize</function>. </para> - + <note><para>This function was added in version 0.1</para></note> </refsect1> </refentry> - <refentry id="function.imagick-resize"> + <refentry id="function.imagick-copy-resize"> <refnamediv> - <refname>imagick_resize</refname> + <refname>imagick_copy_resize</refname> <refpurpose> - Scales an image to the desired dimensions with a filter. + Scales an image to the desired dimensions with a filter and returns a new handle. </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>imagick_resize</function></funcdef> + <funcdef>resource <function>imagick_copy_resize</function></funcdef> <paramdef>resource <parameter>imagick_handle</parameter></paramdef> <paramdef>int <parameter>width</parameter></paramdef> <paramdef>int <parameter>height</parameter></paramdef> @@ -559,7 +560,7 @@ </funcsynopsis> &warn.experimental.func; <para> - Returns: &true; on success, &false; + Returns: a new handle on success, &false; on error. </para> <para> @@ -585,44 +586,26 @@ <parameter>blur</parameter> means the blur factor where > 1 is blurry, < 1 is sharp. </para> <para> - See also: <function>imagick_sample</function>. + See also: <function>imagick_copy_sample</function>. </para> - + <note><para>This function was added in version 0.1</para></note> </refsect1> </refentry> - <refentry id="function.list-magickinfo"> - <refnamediv> - <refname>imagick_list-magickinfo</refname> - <refpurpose> - Lists the image formats to a file - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>imagick_sample</function></funcdef> - <paramdef>string <parameter>filename</parameter></paramdef> - </funcprototype> - </funcsynopsis> - &warn.experimental.func; - </refsect1> - </refentry> - <refentry id="function.imagick-rotate"> + <refentry id="function.imagick-copy-rotate"> <refnamediv> - <refname>imagick_rotate</refname> + <refname>imagick_copy_rotate</refname> <refpurpose> - Rotates a picture + Rotates a picture and returns a new handle </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>imagick_rotate</function></funcdef> + <funcdef>resource <function>imagick_copy_rotate</function></funcdef> <paramdef>resource <parameter>imagick_handle</parameter></paramdef> <paramdef>double <parameter>degrees</parameter></paramdef> </funcprototype> @@ -635,23 +618,23 @@ corners. Empty triangles left over from rotating the image are filled with the color defined by the pixel at location (0,0). </para> - + <note><para>This function was added in version 0.1</para></note> </refsect1> </refentry> - <refentry id="function.imagick-shear"> + <refentry id="function.imagick-copy-shear"> <refnamediv> - <refname>imagick_shear</refname> + <refname>imagick_copy_shear</refname> <refpurpose> - Sheares a picture + Sheares a picture and returns a new handle </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>imagick_shear</function></funcdef> + <funcdef>resource <function>imagick_copy_shear</function></funcdef> <paramdef>resource <parameter>imagick_handle</parameter></paramdef> <paramdef>double <parameter>x_shear</parameter></paramdef> <paramdef>double <parameter>y_shear</parameter></paramdef> @@ -670,23 +653,23 @@ defined by the pixel at location (0,0). </para> - + <note><para>This function was added in version 0.1</para></note> </refsect1> </refentry> - <refentry id="function.imagick-morph"> + <refentry id="function.imagick-copy-morph"> <refnamediv> - <refname>imagick_morph</refname> + <refname>imagick_copy_morph</refname> <refpurpose> - Morphes at least 2 pictures + Morphes at least 2 pictures and returns a new handle </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcprototype> - <funcdef>bool <function>imagick_morph</function></funcdef> + <funcdef>resource <function>imagick_copy_morph</function></funcdef> <paramdef>resource <parameter>imagick_handle</parameter></paramdef> <paramdef>long <parameter>number_frames</parameter></paramdef> </funcprototype> @@ -698,7 +681,7 @@ a number of intervening images as specified by frames. </para> - + <note><para>This function was added in version 0.1</para></note> </refsect1> </refentry> @@ -746,6 +729,25 @@ </refentry> + <refentry id="function.list-magickinfo"> + <refnamediv> + <refname>imagick_list-magickinfo</refname> + <refpurpose> + Lists the image formats to a file + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>bool <function>imagick_sample</function></funcdef> + <paramdef>string <parameter>filename</parameter></paramdef> + </funcprototype> + </funcsynopsis> + &warn.experimental.func; + </refsect1> + </refentry> + <refentry id="function.imagick-dump"> <refnamediv>