reference/image/functions/imagefilltoborder.xml
593ea510e853ff034e03f78a4be0daa41661c9d4
593ea510e853ff034e03f78a4be0daa41661c9d4
...
...
@@ -9,15 +9,15 @@
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
11
<type>bool</type><methodname>imagefilltoborder</methodname>
12
-
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
12
+
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
13
13
<methodparam><type>int</type><parameter>x</parameter></methodparam>
14
14
<methodparam><type>int</type><parameter>y</parameter></methodparam>
15
-
<methodparam><type>int</type><parameter>border</parameter></methodparam>
15
+
<methodparam><type>int</type><parameter>border_color</parameter></methodparam>
16
16
<methodparam><type>int</type><parameter>color</parameter></methodparam>
17
17
</methodsynopsis>
18
18
<para>
19
19
<function>imagefilltoborder</function> performs a flood fill
20
-
whose border color is defined by <parameter>border</parameter>.
20
+
whose border color is defined by <parameter>border_color</parameter>.
21
21
The starting point for the fill is <parameter>x</parameter>,
22
22
<parameter>y</parameter> (top left is 0, 0) and the region is
23
23
filled with color <parameter>color</parameter>.
...
...
@@ -45,11 +45,10 @@
45
45
</listitem>
46
46
</varlistentry>
47
47
<varlistentry>
48
-
<term><parameter>border</parameter></term>
48
+
<term><parameter>border_color</parameter></term>
49
49
<listitem>
50
50
<para>
51
-
The border color. A color identifier created with
52
-
<function>imagecolorallocate</function>.
51
+
The border color. &gd.identifier.color;
53
52
</para>
54
53
</listitem>
55
54
</varlistentry>
...
...
@@ -57,8 +56,7 @@
57
56
<term><parameter>color</parameter></term>
58
57
<listitem>
59
58
<para>
60
-
The fill color. A color identifier created with
61
-
<function>imagecolorallocate</function>.
59
+
The fill color. &gd.identifier.color;
62
60
</para>
63
61
</listitem>
64
62
</varlistentry>
...
...
@@ -71,6 +69,24 @@
71
69
&return.success;
72
70
</para>
73
71
</refsect1>
72
+
73
+
<refsect1 role="changelog">
74
+
&reftitle.changelog;
75
+
<informaltable>
76
+
<tgroup cols="2">
77
+
<thead>
78
+
<row>
79
+
<entry>&Version;</entry>
80
+
<entry>&Description;</entry>
81
+
</row>
82
+
</thead>
83
+
<tbody>
84
+
&gd.changelog.image-param;
85
+
</tbody>
86
+
</tgroup>
87
+
</informaltable>
88
+
</refsect1>
89
+
74
90
<refsect1 role="examples">
75
91
&reftitle.examples;
76
92
<para>
...
...
@@ -104,14 +120,25 @@ imagedestroy($im);
104
120
<mediaobject>
105
121
<alt>Output of example : Filling an ellipse with a color</alt>
106
122
<imageobject>
107
-
<imagedata fileref="en/reference/image/figures/imagefilltoborder.png" />
123
+
<imagedata fileref="en/reference/image/figures/imagefilltoborder.png"/>
108
124
</imageobject>
109
125
</mediaobject>
110
126
</example>
111
127
</para>
112
128
</refsect1>
113
-
</refentry>
114
129
130
+
<refsect1 role="notes">
131
+
&reftitle.notes;
132
+
<simpara>
133
+
The algorithm does not explicitly remember which pixels have
134
+
already been set, but rather infers that from the color of the
135
+
pixel, so it cannot distinguish between freshly set pixels and
136
+
pixels that are already there. That means chosing any fill color
137
+
that is already used in the image may yield undesired results.
138
+
</simpara>
139
+
</refsect1>
140
+
141
+
</refentry>
115
142
<!-- Keep this comment at the end of the file
116
143
Local variables:
117
144
mode: sgml
118
145