<!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>Flips an image using a given mode</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagefilter.html">imagefilter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagefontheight.html">imagefontheight</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.imageflip" class="refentry">
<div class="refnamediv">
<h1 class="refname">imageflip</h1>
<p class="verinfo">(PHP 5 >= 5.5.0)</p><p class="refpurpose"><span class="refname">imageflip</span> — <span class="dc-title">Flips an image using a given mode</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imageflip-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imageflip</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">$mode</code></span>
)</div>
<p class="para rdfs-comment">
Flips the <em><code class="parameter">image</code></em> image using the given
<em><code class="parameter">mode</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imageflip-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">mode</code></em></span>
<dd>
<p class="para">
Flip mode, this can be one of the <strong><code>IMG_FLIP_*</code></strong> constants:
</p>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Constant</th>
<th>Meaning</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td><strong><code>IMG_FLIP_HORIZONTAL</code></strong></td>
<td>
Flips the image horizontally.
</td>
</tr>
<tr>
<td><strong><code>IMG_FLIP_VERTICAL</code></strong></td>
<td>
Flips the image vertically.
</td>
</tr>
<tr>
<td><strong><code>IMG_FLIP_BOTH</code></strong></td>
<td>
Flips the image both horizontally and vertically.
</td>
</tr>
</tbody>
</table>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imageflip-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.imageflip-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3236">
<p><strong>Example #1 Flips an image vertically</strong></p>
<div class="example-contents"><p>
This example uses the <strong><code>IMG_FLIP_VERTICAL</code></strong>
constant.
</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<br /></span><span style="color: #0000BB">$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">'phplogo.png'</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/png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Load<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatefrompng</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Flip it vertically<br /></span><span style="color: #0000BB">imageflip</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">IMG_FLIP_VERTICAL</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">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</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-imageflipvertical.png" alt="Output of example: Vertically flipped image" width="120" height="67" />
</div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-3237">
<p><strong>Example #2 Flips the image horizontally</strong></p>
<div class="example-contents"><p>
This example uses the <strong><code>IMG_FLIP_HORIZONTAL</code></strong> constant.
</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<br /></span><span style="color: #0000BB">$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">'phplogo.png'</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/png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Load<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatefrompng</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Flip it horizontally<br /></span><span style="color: #0000BB">imageflip</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">IMG_FLIP_HORIZONTAL</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">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</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-imagefliphorizontal.png" alt="Output of example: Horizontally flipped image" width="120" height="67" />
</div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.imageflip-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>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagefilter.html">imagefilter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagefontheight.html">imagefontheight</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>
