<!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>Composites an image onto the current image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagickdraw.comment.html">ImagickDraw::comment</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagickdraw.construct.html">ImagickDraw::__construct</a></div>
<div class="up"><a href="class.imagickdraw.html">ImagickDraw</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagickdraw.composite" class="refentry">
<div class="refnamediv">
<h1 class="refname">ImagickDraw::composite</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">ImagickDraw::composite</span> — <span class="dc-title">Composites an image onto the current image</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagickdraw.composite-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ImagickDraw::composite</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compose</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$x</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$y</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$width</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$height</code></span>
, <span class="methodparam"><span class="type"><a href="class.imagick.html" class="type Imagick">Imagick</a></span> <code class="parameter">$compositeWand</code></span>
)</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
<p class="para">
Composites an image onto the current image, using the specified
composition operator, specified position, and at the specified size.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagickdraw.composite-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">compose</code></dt>
<dd>
<p class="para">
composition operator. One of COMPOSITE_ constants
</p>
</dd>
<dt>
<code class="parameter">x</code></dt>
<dd>
<p class="para">
x coordinate of the top left corner
</p>
</dd>
<dt>
<code class="parameter">y</code></dt>
<dd>
<p class="para">
y coordinate of the top left corner
</p>
</dd>
<dt>
<code class="parameter">width</code></dt>
<dd>
<p class="para">
width of the composition image
</p>
</dd>
<dt>
<code class="parameter">height</code></dt>
<dd>
<p class="para">
height of the composition image
</p>
</dd>
<dt>
<code class="parameter">compositeWand</code></dt>
<dd>
<p class="para">
the Imagick object where composition image is taken from
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagickdraw.composite-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagickdraw.composite-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="classname.methodname.example.basic">
<p><strong>Example #1 <span class="function"><strong>ImagickDraw::composite()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">composite</span><span style="color: #007700">(</span><span style="color: #0000BB">$strokeColor</span><span style="color: #007700">, </span><span style="color: #0000BB">$fillColor</span><span style="color: #007700">, </span><span style="color: #0000BB">$backgroundColor</span><span style="color: #007700">) {<br /><br /> </span><span style="color: #0000BB">$draw </span><span style="color: #007700">= new \</span><span style="color: #0000BB">ImagickDraw</span><span style="color: #007700">();<br /><br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setStrokeColor</span><span style="color: #007700">(</span><span style="color: #0000BB">$strokeColor</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFillColor</span><span style="color: #007700">(</span><span style="color: #0000BB">$fillColor</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFillOpacity</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setStrokeWidth</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFontSize</span><span style="color: #007700">(</span><span style="color: #0000BB">72</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setStrokeOpacity</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setStrokeColor</span><span style="color: #007700">(</span><span style="color: #0000BB">$strokeColor</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setStrokeWidth</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFont</span><span style="color: #007700">(</span><span style="color: #DD0000">"../fonts/CANDY.TTF"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFontSize</span><span style="color: #007700">(</span><span style="color: #0000BB">140</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">rectangle</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">1000</span><span style="color: #007700">, </span><span style="color: #0000BB">300</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setFillColor</span><span style="color: #007700">(</span><span style="color: #DD0000">'white'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">setfillopacity</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$draw</span><span style="color: #007700">-></span><span style="color: #0000BB">annotation</span><span style="color: #007700">(</span><span style="color: #0000BB">50</span><span style="color: #007700">, </span><span style="color: #0000BB">180</span><span style="color: #007700">, </span><span style="color: #DD0000">"Lorem Ipsum!"</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">//Create an image object which the draw commands can be rendered into<br /> </span><span style="color: #0000BB">$imagick </span><span style="color: #007700">= new \</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">newImage</span><span style="color: #007700">(</span><span style="color: #0000BB">1000</span><span style="color: #007700">, </span><span style="color: #0000BB">302</span><span style="color: #007700">, </span><span style="color: #0000BB">$backgroundColor</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">setImageFormat</span><span style="color: #007700">(</span><span style="color: #DD0000">"png"</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">//Render the draw commands in the ImagickDraw object <br /> //into the image.<br /> </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">drawImage</span><span style="color: #007700">(</span><span style="color: #0000BB">$draw</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">//Send the image 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 /> echo </span><span style="color: #0000BB">$imagick</span><span style="color: #007700">-></span><span style="color: #0000BB">getImageBlob</span><span style="color: #007700">();<br />}<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="imagickdraw.comment.html">ImagickDraw::comment</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagickdraw.construct.html">ImagickDraw::__construct</a></div>
<div class="up"><a href="class.imagickdraw.html">ImagickDraw</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
