<!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 color mask of the image</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="haruimage.getwidth.html">HaruImage::getWidth</a></div>
<div class="next" style="text-align: right; float: right;"><a href="haruimage.setmaskimage.html">HaruImage::setMaskImage</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.setcolormask" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruImage::setColorMask</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruImage::setColorMask</span> — <span class="dc-title">Set the color mask of the image</span></p>
</div>
<div class="refsect1 description" id="refsect1-haruimage.setcolormask-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>HaruImage::setColorMask</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$rmin</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$rmax</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$gmin</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$gmax</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$bmin</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$bmax</code></span>
)</div>
<p class="para rdfs-comment">
Defines the transparent color of the image using the RGB range values.
The color within the range is displayed as a transparent color.
The color space of the image must be RGB.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-haruimage.setcolormask-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">rmin</code></em></span>
<dd>
<p class="para">
The lower limit of red. Must be between 0 and 255.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">rmax</code></em></span>
<dd>
<p class="para">
The upper limit of red. Must be between 0 and 255.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">gmin</code></em></span>
<dd>
<p class="para">
The lower limit of green. Must be between 0 and 255.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">gmax</code></em></span>
<dd>
<p class="para">
The upper limit of green. Must be between 0 and 255.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">bmin</code></em></span>
<dd>
<p class="para">
The lower limit of blue. Must be between 0 and 255.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">bmax</code></em></span>
<dd>
<p class="para">
The upper limit of blue. Must be between 0 and 255.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-haruimage.setcolormask-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.setcolormask-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.getwidth.html">HaruImage::getWidth</a></div>
<div class="next" style="text-align: right; float: right;"><a href="haruimage.setmaskimage.html">HaruImage::setMaskImage</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>
