1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 299628 $ -->
<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>
<methodparam choice="opt"><type>int</type><parameter>alpha</parameter><initializer>0</initializer></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>
<varlistentry>
<term><parameter>alpha</parameter></term>
<listitem>
<para>
Value of alpha component.
</para>
<para>
&version.trunk.after.53;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>&version.trunk.changelog;</entry>
<entry>
The <parameter>alpha</parameter> parameter was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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:"~/.phpdoc/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
-->
|