<!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>Set the color for the specified palette index</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imagecolorresolvealpha.html">imagecolorresolvealpha</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imagecolorsforindex.html">imagecolorsforindex</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.imagecolorset" class="refentry"> <div class="refnamediv"> <h1 class="refname">imagecolorset</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">imagecolorset</span> — <span class="dc-title">Set the color for the specified palette index</span></p> </div> <div class="refsect1 description" id="refsect1-function.imagecolorset-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>imagecolorset</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> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$red</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$green</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$blue</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$alpha</code><span class="initializer"> = 0</span></span> ] )</div> <p class="para rdfs-comment"> This sets the specified index in the palette to the specified color. This is useful for creating flood-fill-like effects in palleted images without the overhead of performing the actual flood-fill. </p> </div> <div class="refsect1 parameters" id="refsect1-function.imagecolorset-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"> An index in the palette. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">red</code></em></span> <dd> <p class="para">Value of red component.</p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">green</code></em></span> <dd> <p class="para">Value of green component.</p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">blue</code></em></span> <dd> <p class="para">Value of blue component.</p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">alpha</code></em></span> <dd> <p class="para"> Value of alpha component. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.imagecolorset-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No value is returned. </p> </div> <div class="refsect1 changelog" id="refsect1-function.imagecolorset-changelog"> <h3 class="title">Changelog</h3> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>5.4.0</td> <td> The <em><code class="parameter">alpha</code></em> parameter was added. </td> </tr> </tbody> </table> </div> <div class="refsect1 examples" id="refsect1-function.imagecolorset-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-3196"> <p><strong>Example #1 <span class="function"><strong>imagecolorset()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Create a 300x100 image<br /></span><span style="color: #0000BB">$im </span><span style="color: #007700">= </span><span style="color: #0000BB">imagecreate</span><span style="color: #007700">(</span><span style="color: #0000BB">300</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Set the background to be red<br /></span><span style="color: #0000BB">imagecolorallocate</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Get the color index for the background<br /></span><span style="color: #0000BB">$bg </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">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Set the backgrund to be blue<br /></span><span style="color: #0000BB">imagecolorset</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">, </span><span style="color: #0000BB">$bg</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Output the image to the browser<br /></span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">'Content-Type: image/png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">imagepng</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">imagedestroy</span><span style="color: #007700">(</span><span style="color: #0000BB">$im</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.imagecolorset-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> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.imagecolorresolvealpha.html">imagecolorresolvealpha</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.imagecolorsforindex.html">imagecolorsforindex</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>