<!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>Set the image mask</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="haruimage.setcolormask.html">HaruImage::setColorMask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.haruencoder.html">HaruEncoder</a></div>
<div class="up"><a href="class.haruimage.html">HaruImage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="haruimage.setmaskimage" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruImage::setMaskImage</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruImage::setMaskImage</span> — <span class="dc-title">Set the image mask</span></p>
</div>
<div class="refsect1 description" id="refsect1-haruimage.setmaskimage-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>HaruImage::setMaskImage</strong></span>
( <span class="methodparam"><span class="type">object</span> <code class="parameter">$mask_image</code></span>
)</div>
<p class="para rdfs-comment">
Sets the image used as image-mask. It must be 1bit gray-scale color image.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-haruimage.setmaskimage-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">mask_image</code></em></span>
<dd>
<p class="para">
A valid <a href="class.haruimage.html" class="classname">HaruImage</a> instance.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-haruimage.setmaskimage-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-haruimage.setmaskimage-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.html" class="classname">HaruException</a> on error.</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="haruimage.setcolormask.html">HaruImage::setColorMask</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.haruencoder.html">HaruEncoder</a></div>
<div class="up"><a href="class.haruimage.html">HaruImage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
