roundcorners.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagick.roundcorners">
 <refnamediv>
  <refname>Imagick::roundCorners</refname>
  <refpurpose>Rounds image corners</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
   &imagick.deprecated.function-3-4-4;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>Imagick::roundCorners</methodname>
   <methodparam><type>float</type><parameter>x_rounding</parameter></methodparam>
   <methodparam><type>float</type><parameter>y_rounding</parameter></methodparam>
   <methodparam choice="opt"><type>float</type><parameter>stroke_width</parameter><initializer>10</initializer></methodparam>   
   <methodparam choice="opt"><type>float</type><parameter>displace</parameter><initializer>5</initializer></methodparam>   
   <methodparam choice="opt"><type>float</type><parameter>size_correction</parameter><initializer>-6</initializer></methodparam>   
  </methodsynopsis>
  <para>
   Rounds image corners. The first two parameters control the amount 
   of rounding and the three last parameters can be used to fine-tune 
   the rounding process. &imagick.method.available.0x629;
   &imagick.method.not.available.0x700;
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>x_rounding</parameter></term>
     <listitem>
      <para>
       x rounding
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>y_rounding</parameter></term>
     <listitem>
      <para>
       y rounding
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>stroke_width</parameter></term>
     <listitem>
      <para>
        stroke width
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>displace</parameter></term>
     <listitem>
      <para>
        image displace
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size_correction</parameter></term>
     <listitem>
      <para>
        size correction
      </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::roundCorners</function>:</title>
    <para>
     Rounds the image corners
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$image = new Imagick();
$image->newPseudoImage(100, 100, "magick:rose");
$image->setImageFormat("png");

$image->roundCorners(5,3);
$image->writeImage("rounded.png");
?>
]]>
    </programlisting>
   </example>
  </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
-->