<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Draws a polygon</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imagepng.html">imagepng</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imagepsbbox.html">imagepsbbox</a></div> <div class="up"><a href="ref.image.html">GD and Image Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.imagepolygon" class="refentry"> <div class="refnamediv"> <h1 class="refname">imagepolygon</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imagepolygon</span> — <span class="dc-title">Draws a polygon</span></p> </div> <div class="refsect1 description" id="refsect1-function.imagepolygon-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>imagepolygon</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$image</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter">$points</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$num_points</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$color</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>imagepolygon()</strong></span> creates a polygon in the given <em><code class="parameter">image</code></em>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.imagepolygon-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter"> image</code></em></span><dd> <p class="para">An image resource, returned by one of the image creation functions, such as <span class="function"><a href="function.imagecreatetruecolor.html" class="function">imagecreatetruecolor()</a></span>.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">points</code></em></span> <dd> <p class="para"> An array containing the polygon's vertices, e.g.: <table class="doctable informaltable"> <tbody class="tbody"> <tr> <td>points[0]</td> <td>= x0</td> </tr> <tr> <td>points[1]</td> <td>= y0</td> </tr> <tr> <td>points[2]</td> <td>= x1</td> </tr> <tr> <td>points[3]</td> <td>= y1</td> </tr> </tbody> </table> </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">num_points</code></em></span> <dd> <p class="para"> Total number of points (vertices). </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">color</code></em></span> <dd> <p class="para"> A color identifier created with <span class="function"><a href="function.imagecolorallocate.html" class="function">imagecolorallocate()</a></span>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.imagepolygon-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.imagepolygon-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3263"> <p><strong>Example #1 <span class="function"><strong>imagepolygon()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Create a blank image<br /></span><span style="color: #0000BB">$image </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatetruecolor</span><span style="color: #007700">(</span><span style="color: #0000BB">400</span><span style="color: #007700">, </span><span style="color: #0000BB">300</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Allocate a color for the polygon<br /></span><span style="color: #0000BB">$col_poly </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorallocate</span><span style="color: #007700">(</span><span style="color: #0000BB">$image</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Draw the polygon<br /></span><span style="color: #0000BB">imagepolygon</span><span style="color: #007700">(</span><span style="color: #0000BB">$image</span><span style="color: #007700">, array(<br /> </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">200</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">300</span><span style="color: #007700">, </span><span style="color: #0000BB">200<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">3</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$col_poly</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Output the picture to the browser<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">'Content-type: image/png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">imagepng</span><span style="color: #007700">(</span><span style="color: #0000BB">$image</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$image</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="mediaobject"> <div class="imageobject"> <img src="images/21009b70229598c6a80eef8b45bf282b-imagepolygon.png" alt="Output of example : imagepolygon()" width="400" height="300" /> </div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.imagepolygon-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.imagecreate.html" class="function" rel="rdfs-seeAlso">imagecreate()</a> - Create a new palette based image</span></li> <li class="member"> <span class="function"><a href="function.imagecreatetruecolor.html" class="function" rel="rdfs-seeAlso">imagecreatetruecolor()</a> - Create a new true color image</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imagepng.html">imagepng</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imagepsbbox.html">imagepsbbox</a></div> <div class="up"><a href="ref.image.html">GD and Image Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>