<!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>Copy and merge part of an image with gray scale</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagecopymerge.html">imagecopymerge</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagecopyresampled.html">imagecopyresampled</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.imagecopymergegray" class="refentry">
<div class="refnamediv">
<h1 class="refname">imagecopymergegray</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">imagecopymergegray</span> — <span class="dc-title">Copy and merge part of an image with gray scale</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imagecopymergegray-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>imagecopymergegray</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dst_im</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$src_im</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$dst_x</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$dst_y</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$src_x</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$src_y</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$src_w</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$src_h</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$pct</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>imagecopymergegray()</strong></span> copy a part of <code class="parameter">src_im</code> onto
<code class="parameter">dst_im</code> starting at the x,y coordinates
<code class="parameter">src_x</code>, <code class="parameter">src_y </code> with
a width of <code class="parameter">src_w</code> and a height of
<code class="parameter">src_h</code>. The portion defined will be copied
onto the x,y coordinates, <code class="parameter">dst_x</code> and
<code class="parameter">dst_y</code>.
</p>
<p class="para">
This function is identical to <span class="function"><a href="function.imagecopymerge.html" class="function">imagecopymerge()</a></span> except
that when merging it preserves the hue of the source by converting
the destination pixels to gray scale before the copy operation.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imagecopymergegray-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">dst_im</code></dt>
<dd>
<p class="para">Destination image link resource.</p>
</dd>
<dt>
<code class="parameter">src_im</code></dt>
<dd>
<p class="para">Source image link resource.</p>
</dd>
<dt>
<code class="parameter">dst_x</code></dt>
<dd>
<p class="para">
x-coordinate of destination point.
</p>
</dd>
<dt>
<code class="parameter">dst_y</code></dt>
<dd>
<p class="para">
y-coordinate of destination point.
</p>
</dd>
<dt>
<code class="parameter">src_x</code></dt>
<dd>
<p class="para">
x-coordinate of source point.
</p>
</dd>
<dt>
<code class="parameter">src_y</code></dt>
<dd>
<p class="para">
y-coordinate of source point.
</p>
</dd>
<dt>
<code class="parameter">src_w</code></dt>
<dd>
<p class="para">Source width.</p>
</dd>
<dt>
<code class="parameter">src_h</code></dt>
<dd>
<p class="para">Source height.</p>
</dd>
<dt>
<code class="parameter">pct</code></dt>
<dd>
<p class="para">
The <code class="parameter">src_im</code> will be changed to grayscale according
to <code class="parameter">pct</code> where 0 is fully grayscale and 100 is
unchanged. When <code class="parameter">pct</code> = 100 this function behaves
identically to <span class="function"><a href="function.imagecopy.html" class="function">imagecopy()</a></span> for pallete images, except for
ignoring alpha components, while
it implements alpha transparency for true colour images.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imagecopymergegray-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.imagecopymergegray-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3767">
<p><strong>Example #1 <span class="function"><strong>imagecopymergegray()</strong></span> usage</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 image instances<br /></span><span style="color: #0000BB">$dest </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatefromgif</span><span style="color: #007700">(</span><span style="color: #DD0000">'php.gif'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$src </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatefromgif</span><span style="color: #007700">(</span><span style="color: #DD0000">'php.gif'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Copy and merge - Gray = 20%<br /></span><span style="color: #0000BB">imagecopymergegray</span><span style="color: #007700">(</span><span style="color: #0000BB">$dest</span><span style="color: #007700">, </span><span style="color: #0000BB">$src</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #0000BB">10</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">100</span><span style="color: #007700">, </span><span style="color: #0000BB">47</span><span style="color: #007700">, </span><span style="color: #0000BB">20</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/gif'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagegif</span><span style="color: #007700">(</span><span style="color: #0000BB">$dest</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$dest</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$src</span><span style="color: #007700">);<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="function.imagecopymerge.html">imagecopymerge</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagecopyresampled.html">imagecopyresampled</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>
