<!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>Returns the color</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagickpixel.destroy.html">ImagickPixel::destroy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagickpixel.getcolorasstring.html">ImagickPixel::getColorAsString</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.getcolor" class="refentry">
<div class="refnamediv">
<h1 class="refname">ImagickPixel::getColor</h1>
<p class="verinfo">(PECL imagick 2.0.0)</p><p class="refpurpose"><span class="refname">ImagickPixel::getColor</span> — <span class="dc-title">Returns the color</span></p>
</div>
<div class="refsect1 description" id="refsect1-imagickpixel.getcolor-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>ImagickPixel::getColor</strong></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$normalized</code><span class="initializer"> = false</span></span>
] )</div>
<p class="para rdfs-comment">
Returns the color described by the ImagickPixel object, as an array. If the color has an
opacity channel set, this is provided as a fourth value in the list.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-imagickpixel.getcolor-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">normalized</code></em></span>
<dd>
<p class="para">
Normalize the color values
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-imagickpixel.getcolor-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
An array of channel values, each normalized if <strong><code>TRUE</code></strong> is given as param. Throws
ImagickPixelException on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-imagickpixel.getcolor-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3346">
<p><strong>Example #1 Basic <span class="function"><strong>Imagick::getColor()</strong></span> usage</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 ImagickPixel with the predefined color 'brown'<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">//Set the color to have an alpha of 25%<br /></span><span style="color: #0000BB">$color</span><span style="color: #007700">-></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">-></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">-></span><span style="color: #0000BB">getColor</span><span style="color: #007700">(</span><span style="color: #0000BB">true</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">?></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>
Standard values
Array
(
[r] => 165
[g] => 42
[b] => 42
[a] => 0
)
Normalized values:
Array
(
[r] => 0.64705882352941
[g] => 0.16470588235294
[b] => 0.16470588235294
[a] => 0.25000381475547
)
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="imagickpixel.destroy.html">ImagickPixel::destroy</a></div>
<div class="next" style="text-align: right; float: right;"><a href="imagickpixel.getcolorasstring.html">ImagickPixel::getColorAsString</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>
