<!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>Draw a rectangle</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagepstext.html">imagepstext</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagerotate.html">imagerotate</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.imagerectangle" class="refentry">
<div class="refnamediv">
<h1 class="refname">imagerectangle</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imagerectangle</span> — <span class="dc-title">Draw a rectangle</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imagerectangle-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imagerectangle</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$image</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$x1</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$y1</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$x2</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$y2</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>imagerectangle()</strong></span> creates a rectangle starting at
the specified coordinates.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imagerectangle-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">x1</code></em></span>
<dd>
<p class="para">
Upper left x coordinate.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">y1</code></em></span>
<dd>
<p class="para">
Upper left y coordinate
0, 0 is the top left corner of the image.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">x2</code></em></span>
<dd>
<p class="para">
Bottom right x coordinate.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">y2</code></em></span>
<dd>
<p class="para">
Bottom right y coordinate.
</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.imagerectangle-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.imagerectangle-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3271">
<p><strong>Example #1 Simple <span class="function"><strong>imagerectangle()</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 200 x 200 image<br /></span><span style="color: #0000BB">$canvas </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatetruecolor</span><span style="color: #007700">(</span><span style="color: #0000BB">200</span><span style="color: #007700">, </span><span style="color: #0000BB">200</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Allocate colors<br /></span><span style="color: #0000BB">$pink </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorallocate</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">105</span><span style="color: #007700">, </span><span style="color: #0000BB">180</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$white </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorallocate</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</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 /></span><span style="color: #0000BB">$green </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorallocate</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</span><span style="color: #007700">, </span><span style="color: #0000BB">132</span><span style="color: #007700">, </span><span style="color: #0000BB">135</span><span style="color: #007700">, </span><span style="color: #0000BB">28</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Draw three rectangles each with its own color<br /></span><span style="color: #0000BB">imagerectangle</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">, </span><span style="color: #0000BB">50</span><span style="color: #007700">, </span><span style="color: #0000BB">150</span><span style="color: #007700">, </span><span style="color: #0000BB">150</span><span style="color: #007700">, </span><span style="color: #0000BB">$pink</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagerectangle</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</span><span style="color: #007700">, </span><span style="color: #0000BB">45</span><span style="color: #007700">, </span><span style="color: #0000BB">60</span><span style="color: #007700">, </span><span style="color: #0000BB">120</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">$white</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagerectangle</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">, </span><span style="color: #0000BB">120</span><span style="color: #007700">, </span><span style="color: #0000BB">75</span><span style="color: #007700">, </span><span style="color: #0000BB">160</span><span style="color: #007700">, </span><span style="color: #0000BB">$green</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Output and free from memory<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">'Content-Type: image/jpeg'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">imagejpeg</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$canvas</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-imagerectangle.jpg" alt="Output of example : Simple imagerectangle() example" width="200" height="200" />
</div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagepstext.html">imagepstext</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagerotate.html">imagerotate</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>
