<!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>Sets the normalized HSL color</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagickpixel.setcolorvalue.html">ImagickPixel::setColorValue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.imagickpixeliterator.html">ImagickPixelIterator</a></div>
<div class="up"><a href="class.imagickpixel.html">ImagickPixel</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="imagickpixel.sethsl" class="refentry">
<div class="refnamediv">
<h1 class="refname">ImagickPixel::setHSL</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">ImagickPixel::setHSL</span> — <span class="dc-title">Sets the normalized HSL color</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagickpixel.sethsl-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ImagickPixel::setHSL</strong></span>
( <span class="methodparam"><span class="type">float</span> <code class="parameter">$hue</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$saturation</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$luminosity</code></span>
)</div>
<p class="para rdfs-comment">
Sets the color described by the ImagickPixel object using normalized
values for hue, saturation and luminosity.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagickpixel.sethsl-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">hue</code></em></span>
<dd>
<p class="para">
The normalized value for hue, described as a fractional arc
(between 0 and 1) of the hue circle, where the zero value is
red.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">saturation</code></em></span>
<dd>
<p class="para">
The normalized value for saturation, with 1 as full saturation.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">luminosity</code></em></span>
<dd>
<p class="para">
The normalized value for luminosity, on a scale from black at
0 to white at 1, with the full HS value at 0.5 luminosity.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagickpixel.sethsl-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-imagickpixel.sethsl-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3351">
<p><strong>Example #1 Use <span class="function"><strong>ImagickPixel::setHSL()</strong></span> to modify a color</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">//Create an almost pure red color<br /></span><span style="color: #0000BB">$color </span><span style="color: #007700">= new </span><span style="color: #0000BB">ImagickPixel</span><span style="color: #007700">(</span><span style="color: #DD0000">'rgb(90%, 10%, 10%)'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">//Get it's HSL values<br /></span><span style="color: #0000BB">$colorInfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$color</span><span style="color: #007700">-></span><span style="color: #0000BB">getHSL</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//Rotate the hue by 180 degrees<br /></span><span style="color: #0000BB">$newHue </span><span style="color: #007700">= </span><span style="color: #0000BB">$colorInfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'hue'</span><span style="color: #007700">] + </span><span style="color: #0000BB">0.5</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">$newHue </span><span style="color: #007700">> </span><span style="color: #0000BB">1</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$newHue </span><span style="color: #007700">= </span><span style="color: #0000BB">$newHue </span><span style="color: #007700">- </span><span style="color: #0000BB">1</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">//Set the ImagickPixel to the new color<br /></span><span style="color: #0000BB">$colorInfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$color</span><span style="color: #007700">-></span><span style="color: #0000BB">setHSL</span><span style="color: #007700">(</span><span style="color: #0000BB">$newHue</span><span style="color: #007700">, </span><span style="color: #0000BB">$colorInfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'saturation'</span><span style="color: #007700">], </span><span style="color: #0000BB">$colorInfo</span><span style="color: #007700">[</span><span style="color: #DD0000">'luminosity'</span><span style="color: #007700">]);<br /><br /></span><span style="color: #FF8000">//Check that the new color is blue/green<br /></span><span style="color: #0000BB">$colorInfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$color</span><span style="color: #007700">-></span><span style="color: #0000BB">getcolor</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$colorInfo</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[r] => 26
[g] => 230
[b] => 230
[a] => 255
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-imagickpixel.sethsl-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Available with ImageMagick library version 6.2.9 and higher.
</p>
</p></blockquote>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagickpixel.setcolorvalue.html">ImagickPixel::setColorValue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.imagickpixeliterator.html">ImagickPixelIterator</a></div>
<div class="up"><a href="class.imagickpixel.html">ImagickPixel</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
