php-doc-en/reference/image/functions/imagecolorset.xml
Kalle Sommer Nielsen 0ebb1e4ec0 * Fixing minor errors / adding improvements on many gd related functions with help from Ross Masters
* Added watermark examples on the main page based on Pierre's code by Ross Masters
* Added examples for the following functions
 * imagefilter
 * imageftbbox
 * imagegif
 * imagepsbbox
 * imagettfbbox
 * iptcembed
* Following examples are by Ross Masters
 * imagealphablending
 * imagecolorexact
 * imagecolorexactalpha
 * imagecolormatch
 * imagecolorresolve
 * imagecolorresolvealpha
 * imagegd
 * imagegd2
 * imagelayereffect
 * imagepstext


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@265588 c90b9560-bf6c-de11-be94-00142212c4b1
2008-08-28 19:03:16 +00:00

131 lines
3.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<refentry xml:id="function.imagecolorset" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagecolorset</refname>
<refpurpose>Set the color for the specified palette index</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>imagecolorset</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>int</type><parameter>red</parameter></methodparam>
<methodparam><type>int</type><parameter>green</parameter></methodparam>
<methodparam><type>int</type><parameter>blue</parameter></methodparam>
</methodsynopsis>
<para>
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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
An index in the palette.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>red</parameter></term>
<listitem>
<para>
Value of red component.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>green</parameter></term>
<listitem>
<para>
Value of green component.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blue</parameter></term>
<listitem>
<para>
Value of blue component.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imagecolorset</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Create a 300x100 image
$im = imagecreate(300, 100);
// Set the background to be red
imagecolorallocate($im, 255, 0, 0);
// Get the color index for the background
$bg = imagecolorat($im, 0, 0);
// Set the backgrund to be blue
imagecolorset($im, $bg, 0, 0, 255);
// Output the image to the browser
//header('Content-type: image/png');
imagepng($im);
imagedestroy($im);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagecolorat</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->