<!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>Replaces image in the object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagick.setgravity.html">Imagick::setGravity</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setimagealphachannel.html">Imagick::setImageAlphaChannel</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagick.setimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">Imagick::setImage</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">Imagick::setImage</span> — <span class="dc-title">Replaces image in the object</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagick.setimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>Imagick::setImage</strong></span>
( <span class="methodparam"><span class="type"><a href="class.imagick.html" class="type Imagick">Imagick</a></span> <code class="parameter">$replace</code></span>
)</div>
<p class="para rdfs-comment">
Replaces the current image sequence with the image from replace object.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagick.setimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">replace</code></em></span>
<dd>
<p class="para">
The replace Imagick object
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagick.setimage-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-imagick.setimage-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws ImagickException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagick.setimage-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3336">
<p><strong>Example #1 A <span class="function"><strong>Imagick::setImage()</strong></span> example</strong></p>
<div class="example-contents"><p>
An example of using Imagick::setImage()
</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">/* Create the objects */<br /></span><span style="color: #0000BB">$image </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #DD0000">'source.jpg'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$replace </span><span style="color: #007700">= new </span><span style="color: #0000BB">Imagick</span><span style="color: #007700">(</span><span style="color: #DD0000">'replace.jpg'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* source.jpg is replaced with replace.jpg */<br /></span><span style="color: #0000BB">$image</span><span style="color: #007700">-></span><span style="color: #0000BB">setImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$replace</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* output the image */<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 />echo </span><span style="color: #0000BB">$image</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></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="imagick.setgravity.html">Imagick::setGravity</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagick.setimagealphachannel.html">Imagick::setImageAlphaChannel</a></div>
<div class="up"><a href="class.imagick.html">Imagick</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
