cvs: phpdoc /en/reference/imagick/imagick transformimage.xml
| From: | Mikko Koppanen | Date: | Fri, 11 Apr 2008 11:26:40 +0000 |
| Subject: | cvs: phpdoc /en/reference/imagick/imagick transformimage.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-1467@lists.php.net to get a copy of this message | ||
mkoppanen Fri Apr 11 11:26:40 2008 UTC
Added files:
/phpdoc/en/reference/imagick/imagick transformimage.xml
Log:
Added Imagick::transformImage documentation.
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/imagick/imagick/transformimage.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/imagick/imagick/transformimage.xml
+++ phpdoc/en/reference/imagick/imagick/transformimage.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook"
xml:id="function.imagick-transformimage">
<refnamediv>
<refname>Imagick::transformImage</refname>
<refpurpose>Convenience method for setting crop size and the image
geometry</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>Imagick</type><methodname>Imagick::transformImage</methodname>
<methodparam><type>string</type><parameter>crop</parameter></methodparam>
<methodparam><type>string</type><parameter>geometry</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
A convenience method for setting crop size and the image geometry from strings
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>crop</parameter></term>
<listitem>
<para>
A crop geometry string. This geometry defines a subregion of the image to crop.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>geometry</parameter></term>
<listitem>
<para>
An image geometry string. This geometry defines the final size of the image.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&imagick.return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Using <function>Imagick::transformImage</function>:</title>
<para>
The example creates a 100x100 black image.
</para>
<programlisting role="php">
<![CDATA[
<?php
$image = new Imagick();
$image->newImage( 300, 200, "black" );
$new_image = $image->transformImage( "100x100", "100x100" );
$new_image->writeImage('test_out.jpg');
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Imagick::adaptiveBlurImage</function></member>
<member><function>Imagick::motionBlurImage</function></member>
<member><function>Imagick::radialBlurImage</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:"../../../../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
-->