archived-doc-ja/reference/image/functions/imagepolygon.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 9960a09a5705102bf4dd0ce63e03d9ec716d0015 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.imagepolygon" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagepolygon</refname>
  <refpurpose>多角形を描画する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <simpara>PHP 8.0.0 以降のシグネチャ(名前付き引数をサポートしていません)</simpara>
  <methodsynopsis>
   <type>bool</type><methodname>imagepolygon</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>代替のシグネチャ (PHP 8.1.0 以降は非推奨)</simpara>
  <methodsynopsis>
   <type>bool</type><methodname>imagepolygon</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>imagepolygon</function> は、指定した
   <parameter>image</parameter> に多角形を作成します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &gd.image.description;
    <varlistentry>
     <term><parameter>points</parameter></term>
     <listitem>
      <para>
       多角形の頂点からなる PHP の配列で、
       次のようになります。
       <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>
       頂点の総数。最小でも3でなければなりません。
      </para>
      <simpara>
       代替のシグネチャ(PHP 8.0.0 以降) でこの引数が省略された場合、
       <parameter>points</parameter> は偶数でなければいけません。また、
       <parameter>num_points</parameter> は
       <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>
       引数 <parameter>num_points</parameter> は、推奨されなくなりました。
      </entry>
     </row>
     &gd.changelog.image-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imagepolygon</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// 空の画像を生成します
$image = imagecreatetruecolor(400, 300);

// 多角形の色を選択します
$col_poly = imagecolorallocate($image, 255, 255, 255);

// 多角形を描画します
imagepolygon($image, array(
        0,   0,
        100, 200,
        300, 200
    ),
    3,
    $col_poly);

// 画像を出力します
header('Content-type: image/png');

imagepng($image);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <mediaobject>
     <alt>出力例 : imagepolygon()</alt>
     <imageobject>
      <imagedata fileref="en/reference/image/figures/imagepolygon.png"/>
     </imageobject>
    </mediaobject>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>imagefilledpolygon</function></member>
   <member><function>imageopenpolygon</function></member>
   <member><function>imagecreate</function></member>
   <member><function>imagecreatetruecolor</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
-->