<?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.getcolor.php',
    1 => 'ImagickPixel::getColor',
    2 => '色を返す',
  ),
  'up' => 
  array (
    0 => 'class.imagickpixel.php',
    1 => 'ImagickPixel',
  ),
  'prev' => 
  array (
    0 => 'imagickpixel.destroy.php',
    1 => 'ImagickPixel::destroy',
  ),
  'next' => 
  array (
    0 => 'imagickpixel.getcolorasstring.php',
    1 => 'ImagickPixel::getColorAsString',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/imagick/imagickpixel/getcolor.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="imagickpixel.getcolor" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ImagickPixel::getColor</h1>
  <p class="verinfo">(PECL imagick 2, PECL imagick 3)</p><p class="refpurpose"><span class="refname">ImagickPixel::getColor</span> &mdash; <span class="dc-title">色を返す</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-imagickpixel.getcolor-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>ImagickPixel::getColor</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$normalized</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   ImagickPixel オブジェクトの色を、配列で返します。透明度が設定されている場合は、
   4 つの要素からなる配列となります。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-imagickpixel.getcolor-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">normalized</code></dt>
     <dd>
      <p class="para">
       色を正規化する。
       有効な値は
       <code class="literal">0</code>,
       <code class="literal">1</code>, <code class="literal">2</code> です。
      </p>
      <table class="doctable table">
       <caption><strong>
        <code class="parameter">normalized</code> で有効な値の一覧
       </strong></caption>
       
        <thead>
         <tr>
          <th><code class="parameter">normalized</code></th>
          <th>説明</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>
           <strong><code>0</code></strong>
          </td>
          <td>
           RGB の値を <code class="literal">0</code> から <code class="literal">255</code> の間の値を取る
           <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> として返します (0 と 255 を含みます)。
           アルファの値を <code class="literal">0</code> または <code class="literal">1</code> の
           <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> として返します。
          </td>
         </tr>

         <tr>
          <td>
           <strong><code>1</code></strong>
          </td>
          <td>
           RGBA の値を <code class="literal">0</code> から <code class="literal">1</code> の間の値を取る
           <span class="type"><a href="language.types.float.php" class="type float">float</a></span> として返します (0 と 1 を含みます)。
          </td>
         </tr>

         <tr>
          <td>
           <strong><code>2</code></strong>
          </td>
          <td>
           RGBA の値を <code class="literal">0</code> から <code class="literal">255</code> の間の値を取る
           <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> として返します (0 と 255 を含みます)。
          </td>
         </tr>

        </tbody>
       
      </table>

     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-imagickpixel.getcolor-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   各チャネルの値を配列で返します。
   エラー時には ImagickPixelException をスローします。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-imagickpixel.getcolor-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 基本的な <span class="function"><strong>Imagick::getColor()</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">// 定義済みの色 'brown' で ImagickPixel を作ります<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">'brown'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// アルファ値を 25% にします<br /></span><span style="color: #0000BB">$color</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setColorValue</span><span style="color: #007700">(</span><span style="color: #0000BB">Imagick</span><span style="color: #007700">::</span><span style="color: #0000BB">COLOR_ALPHA</span><span style="color: #007700">, </span><span style="color: #0000BB">64 </span><span style="color: #007700">/ </span><span style="color: #0000BB">256.0</span><span style="color: #007700">);<br /><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 /><br />echo </span><span style="color: #DD0000">"Standard values"</span><span style="color: #007700">.</span><span style="color: #0000BB">PHP_EOL</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">$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">(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"Normalized values:"</span><span style="color: #007700">.</span><span style="color: #0000BB">PHP_EOL</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">Standard values
Array
(
    [r] =&gt; 165
    [g] =&gt; 42
    [b] =&gt; 42
    [a] =&gt; 0
)
Normalized values:
Array
(
    [r] =&gt; 0.64705882352941
    [g] =&gt; 0.16470588235294
    [b] =&gt; 0.16470588235294
    [a] =&gt; 0.25000381475547
)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


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