1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagepolygon" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagepolygon</refname>
<refpurpose>Draws a 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>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>Alternative signature (deprecated as of 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> creates a polygon in the given
<parameter>image</parameter>.
</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>imagepolygon</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
imagepolygon($image, array(
0, 0,
100, 200,
300, 200
),
3,
$col_poly);
// Output the picture to the browser
header('Content-type: image/png');
imagepng($image);
imagedestroy($image);
?>
]]>
</programlisting>
&example.outputs.similar;
<mediaobject>
<alt>Output of example : 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
-->
|