<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.imagickpixel.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'imagickpixel.sethsl.php',
    1 => 'ImagickPixel::setHSL',
    2 => '正規化した HSL カラーを設定する',
  ),
  'up' => 
  array (
    0 => 'class.imagickpixel.php',
    1 => 'ImagickPixel',
  ),
  'prev' => 
  array (
    0 => 'imagickpixel.setcolorvaluequantum.php',
    1 => 'ImagickPixel::setColorValueQuantum',
  ),
  'next' => 
  array (
    0 => 'imagickpixel.setindex.php',
    1 => 'ImagickPixel::setIndex',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/imagick/imagickpixel/sethsl.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="imagickpixel.sethsl" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ImagickPixel::setHSL</h1>
  <p class="verinfo">(PECL imagick 2, PECL imagick 3)</p><p class="refpurpose"><span class="refname">ImagickPixel::setHSL</span> &mdash; <span class="dc-title">正規化した HSL カラーを設定する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-imagickpixel.sethsl-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>ImagickPixel::setHSL</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$hue</code></span>, <span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$saturation</code></span>, <span class="methodparam"><span class="type"><a href="language.types.float.php" class="type float">float</a></span> <code class="parameter">$luminosity</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   hue (色相)、saturation (彩度) および luminosity (明度) を正規化した値によって
   ImagickPixel オブジェクトの色を設定します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-imagickpixel.sethsl-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">hue</code></dt>
     <dd>
      <p class="para">
       色相を正規化した値。これは、色相環上での位置
       (0 から 1 まで) を表します。ゼロは赤です。
      </p>
     </dd>
    
    
     <dt><code class="parameter">saturation</code></dt>
     <dd>
      <p class="para">
       彩度を正規化した値。1 が最大です。
      </p>
     </dd>
    
    
     <dt><code class="parameter">luminosity</code></dt>
     <dd>
      <p class="para">
       明度を正規化した値。黒が 0、白が 1 で、
       0.5 にすると完全な HS 値が再現されます。
      </p>
     </dd>
    
   </dl>
  </p>

 </div>

 <div class="refsect1 returnvalues" id="refsect1-imagickpixel.sethsl-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-imagickpixel.sethsl-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>ImagickPixel::setHSL()</strong></span> による色の変更</strong></p>
    <div class="example-contents">
        <div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// ほぼ真っ赤な色を作ります<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">// その HSL 値を取得します<br /></span><span style="color: #0000BB">$colorInfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$color</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getHSL</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// 色相を 180 度反転させます<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">&gt; </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">// ImagickPixel を新しい色に設定します<br /></span><span style="color: #0000BB">$colorInfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$color</span><span style="color: #007700">-&gt;</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">// 新しい色が青/緑になることを確かめます<br /></span><span style="color: #0000BB">$colorInfo </span><span style="color: #007700">= </span><span style="color: #0000BB">$color</span><span style="color: #007700">-&gt;</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">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>上の例の出力は以下となります。</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Array
(
    [r] =&gt; 26
    [g] =&gt; 230
    [b] =&gt; 230
    [a] =&gt; 255
)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-imagickpixel.sethsl-notes">
  <h3 class="title">注意</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    ImageMagick ライブラリバージョン 6.2.9 以降で使用可能です。
   </p>
  </p></blockquote>
 </div>


</div><?php manual_footer($setup); ?>