<!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>Get the colors for an index</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagecolorset.html">imagecolorset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagecolorstotal.html">imagecolorstotal</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.imagecolorsforindex" class="refentry">
<div class="refnamediv">
<h1 class="refname">imagecolorsforindex</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imagecolorsforindex</span> — <span class="dc-title">Get the colors for an index</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.imagecolorsforindex-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>imagecolorsforindex</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$image</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
)</div>
<p class="para rdfs-comment">
Gets the color for a specified index.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.imagecolorsforindex-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
image</code></em></span><dd>
<p class="para">An image resource, returned by one of the image creation functions,
such as <span class="function"><a href="function.imagecreatetruecolor.html" class="function">imagecreatetruecolor()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">index</code></em></span>
<dd>
<p class="para">
The color index.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.imagecolorsforindex-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an associative array with red, green, blue and alpha keys that
contain the appropriate values for the specified color index.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.imagecolorsforindex-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3197">
<p><strong>Example #1 <span class="function"><strong>imagecolorsforindex()</strong></span> example</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">// open an image<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreatefrompng</span><span style="color: #007700">(</span><span style="color: #DD0000">'nexen.png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// get a color<br /></span><span style="color: #0000BB">$start_x </span><span style="color: #007700">= </span><span style="color: #0000BB">40</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$start_y </span><span style="color: #007700">= </span><span style="color: #0000BB">50</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$color_index </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorat</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">$start_x</span><span style="color: #007700">, </span><span style="color: #0000BB">$start_y</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// make it human readable<br /></span><span style="color: #0000BB">$color_tran </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecolorsforindex</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">$color_index</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// what is it ?<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$color_tran</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[red] => 226
[green] => 222
[blue] => 252
[alpha] => 0
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.imagecolorsforindex-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.imagecolorat.html" class="function" rel="rdfs-seeAlso">imagecolorat()</a> - Get the index of the color of a pixel</span></li>
<li class="member"> <span class="function"><a href="function.imagecolorexact.html" class="function" rel="rdfs-seeAlso">imagecolorexact()</a> - Get the index of the specified color</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.imagecolorset.html">imagecolorset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.imagecolorstotal.html">imagecolorstotal</a></div>
<div class="up"><a href="ref.image.html">GD and Image Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
