imageopenpolygon.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imageopenpolygon" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imageopenpolygon</refname>
  <refpurpose>Draws an open polygon</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <simpara>Signature as of PHP 8.0.0 (not supported with named arguments)</simpara>
  <methodsynopsis>
   <type>bool</type><methodname>imageopenpolygon</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam><type>array</type><parameter>points</parameter></methodparam>
   <methodparam><type>int</type><parameter>color</parameter></methodparam>
  </methodsynopsis>
  <simpara>Alternative signature (deprecated as of PHP 8.1.0)</simpara>
  <methodsynopsis>
   <type>bool</type><methodname>imageopenpolygon</methodname>
   <methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
   <methodparam><type>array</type><parameter>points</parameter></methodparam>
   <methodparam><type>int</type><parameter>num_points</parameter></methodparam>
   <methodparam><type>int</type><parameter>color</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>imageopenpolygon</function> draws an open polygon on the given
   <parameter>image</parameter>. Contrary to <function>imagepolygon</function>,
   no line is drawn between the last and the first point.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>points</parameter></term>
     <listitem>
      <para>
       An array containing the polygon's vertices, e.g.:
       <informaltable>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry>points[0]</entry>
           <entry>= x0</entry>
          </row>
          <row>
           <entry>points[1]</entry>
           <entry>= y0</entry>
          </row>
          <row>
           <entry>points[2]</entry>
           <entry>= x1</entry>
          </row>
          <row>
           <entry>points[3]</entry>
           <entry>= y1</entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>num_points</parameter></term>
     <listitem>
      <para>
       Total number of points (vertices), which must be at least 3.
      </para>
      <simpara>
       If this parameter is omitted as per the second signature, <parameter>points</parameter>
       must have an even number of elements, and <parameter>num_points</parameter> is
       assumed to be <code>count($points)/2</code>.
      </simpara>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>color</parameter></term>
     <listitem>
      <para>
       &gd.identifier.color;
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry>
       The parameter <parameter>num_points</parameter> has been deprecated.
      </entry>
     </row>
     &gd.changelog.image-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imageopenpolygon</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Create a blank image
$image = imagecreatetruecolor(400, 300);

// Allocate a color for the polygon
$col_poly = imagecolorallocate($image, 255, 255, 255);

// Draw the polygon
imageopenpolygon($image, array(
        0,   0,
        100, 200,
        300, 200
    ),
    $col_poly);

// Output the picture to the browser
header('Content-type: image/png');

imagepng($image);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <mediaobject>
     <alt>Output of example : imageopenpolygon()</alt>
     <imageobject>
      <imagedata fileref="en/reference/image/figures/imageopenpolygon.png"/>
     </imageobject>
    </mediaobject>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>imagepolygon</function></member>
  </simplelist>
 </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
-->