<!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>Rotate an image with a given angle</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagerectangle.html">imagerectangle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagesavealpha.html">imagesavealpha</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.imagerotate" class="refentry">
<div class="refnamediv">
<h1 class="refname">imagerotate</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">imagerotate</span> — <span class="dc-title">Rotate an image with a given angle</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imagerotate-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>imagerotate</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$image</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$angle</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$bgd_color</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$ignore_transparent</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
Rotates the <em><code class="parameter">image</code></em> image using the given
<em><code class="parameter">angle</code></em> in degrees.
</p>
<p class="para">
The center of rotation is the center of the image, and the rotated
image may have different dimensions than the original image.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imagerotate-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">angle</code></em></span>
<dd>
<p class="para">
Rotation angle, in degrees. The rotation angle is interpreted as the
number of degrees to rotate the image anticlockwise.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">bgd_color</code></em></span>
<dd>
<p class="para">
Specifies the color of the uncovered zone after the rotation
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">ignore_transparent</code></em></span>
<dd>
<p class="para">
If set and non-zero, transparent colors are ignored (otherwise kept).
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imagerotate-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an image resource for the rotated image, or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.imagerotate-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.5.0</td>
<td>
This function is now affected by the interpolation method set by the
<span class="function"><a href="function.imagesetinterpolation.html" class="function">imagesetinterpolation()</a></span> function.
</td>
</tr>
<tr>
<td>5.1.0</td>
<td>
<em><code class="parameter">ignore_transparent</code></em> was added.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imagerotate-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3272">
<p><strong>Example #1 Rotate an image 180 degrees</strong></p>
<div class="example-contents"><p>
This example rotates an image 180 degrees - upside down.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// File and rotation<br /></span><span style="color: #0000BB">$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">'test.jpg'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$degrees </span><span style="color: #007700">= </span><span style="color: #0000BB">180</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Content type<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: #FF8000">// Load<br /></span><span style="color: #0000BB">$source </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatefromjpeg</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Rotate<br /></span><span style="color: #0000BB">$rotate </span><span style="color: #007700">= </span><span style="color: #0000BB">imagerotate</span><span style="color: #007700">(</span><span style="color: #0000BB">$source</span><span style="color: #007700">, </span><span style="color: #0000BB">$degrees</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Output<br /></span><span style="color: #0000BB">imagejpeg</span><span style="color: #007700">(</span><span style="color: #0000BB">$rotate</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Free the memory<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$source</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$rotate</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-imagerotate.jpg" alt="Output of example : Rotate an image 180 degrees" width="95" height="51" />
</div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imagerotate-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function is only available if
PHP is compiled with the bundled version of the GD library.</span></p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This function is affected by the interpolation method set by <span class="function"><a href="function.imagesetinterpolation.html" class="function">imagesetinterpolation()</a></span>.</p></p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.imagerotate-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imagesetinterpolation.html" class="function" rel="rdfs-seeAlso">imagesetinterpolation()</a> - Set the interpolation method</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.imagerectangle.html">imagerectangle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagesavealpha.html">imagesavealpha</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>
