archived-doc-en/reference/imagick/imagickdraw/roundrectangle.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="imagickdraw.roundrectangle">
 <refnamediv>
  <refname>ImagickDraw::roundRectangle</refname>
  <refpurpose>Draws a rounded rectangle</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>ImagickDraw::roundRectangle</methodname>
   <methodparam><type>float</type><parameter>top_left_x</parameter></methodparam>
   <methodparam><type>float</type><parameter>top_left_y</parameter></methodparam>
   <methodparam><type>float</type><parameter>bottom_right_x</parameter></methodparam>
   <methodparam><type>float</type><parameter>bottom_right_y</parameter></methodparam>
   <methodparam><type>float</type><parameter>rounding_x</parameter></methodparam>
   <methodparam><type>float</type><parameter>rounding_y</parameter></methodparam>
  </methodsynopsis>
  &warn.undocumented.func;
  <para>
   Draws a rounded rectangle given two coordinates, x &amp; y corner radiuses
   and using the current stroke, stroke width, and fill settings.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>top_left_x</parameter></term>
     <listitem>
      <para>
       x coordinate of the top left corner
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>top_left_y</parameter></term>
     <listitem>
      <para>
       y coordinate of the top left corner
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bottom_right_x</parameter></term>
     <listitem>
      <para>
        x coordinate of the bottom right 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bottom_right_y</parameter></term>
     <listitem>
      <para>
       y coordinate of the bottom right 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rounding_x</parameter></term>
     <listitem>
      <para>
       x rounding
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>rounding_y</parameter></term>
     <listitem>
      <para>
       y rounding
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
    <example>
      <title><function>ImagickDraw::roundRectangle</function> example</title>
      <programlisting role="php">
      <![CDATA[
<?php
function roundRectangle($strokeColor, $fillColor, $backgroundColor, $startX, $startY, $endX, $endY, $roundX, $roundY) {

    $draw = new \ImagickDraw();

    $draw->setStrokeColor($strokeColor);
    $draw->setFillColor($fillColor);
    $draw->setStrokeOpacity(1);
    $draw->setStrokeWidth(2);

    $draw->roundRectangle($startX, $startY, $endX, $endY, $roundX, $roundY);

    $imagick = new \Imagick();
    $imagick->newImage(500, 500, $backgroundColor);
    $imagick->setImageFormat("png");

    $imagick->drawImage($draw);

    header("Content-Type: image/png");
    echo $imagick->getImageBlob();
}

?>
]]>
      </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
-->