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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagecropauto" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imagecropauto</refname>
<refpurpose>Crop an image automatically using one of the available modes</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>GdImage</type><type>false</type></type><methodname>imagecropauto</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>IMG_CROP_DEFAULT</constant></initializer></methodparam>
<methodparam choice="opt"><type>float</type><parameter>threshold</parameter><initializer>0.5</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>color</parameter><initializer>-1</initializer></methodparam>
</methodsynopsis>
<para>
Automatically crops an image according to the given
<parameter>mode</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
One of the following constants:
</para>
<variablelist>
<varlistentry>
<term><constant>IMG_CROP_DEFAULT</constant></term>
<listitem>
<simpara>
Same as <constant>IMG_CROP_TRANSPARENT</constant>.
Before PHP 7.4.0, the bundled libgd fell back to <constant>IMG_CROP_SIDES</constant>,
if the image had no transparent color.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_CROP_TRANSPARENT</constant></term>
<listitem>
<simpara>
Crops out a transparent background.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_CROP_BLACK</constant></term>
<listitem>
<simpara>
Crops out a black background.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_CROP_WHITE</constant></term>
<listitem>
<simpara>
Crops out a white background.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_CROP_SIDES</constant></term>
<listitem>
<simpara>
Uses the 4 corners of the image to attempt to detect the background to
crop.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>IMG_CROP_THRESHOLD</constant></term>
<listitem>
<simpara>
Crops an image using the given <parameter>threshold</parameter> and
<parameter>color</parameter>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>threshold</parameter></term>
<listitem>
<para>
Specifies the tolerance in percent to be used while comparing the image
color and the color to crop. The method used to calculate the color
difference is based on the color distance in the RGB(a) cube.
</para>
<para>
Used only in <constant>IMG_CROP_THRESHOLD</constant> mode.
</para>
<note>
<simpara>
Before PHP 7.4.0, the bundled libgd used a somewhat different algorithm,
so the same <parameter>threshold</parameter> yielded different results
for system and bundled libgd.
</simpara>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>color</parameter></term>
<listitem>
<para>
Either an RGB color value or a palette index.
</para>
<para>
Used only in <constant>IMG_CROP_THRESHOLD</constant> mode.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a cropped image object on success&return.falseforfailure;.
&false; is also returned if the whole image was cropped.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&gd.changelog.image-param;
<row>
<entry>8.0.0</entry>
<entry>
On success, this function returns a <classname>GDImage</classname> instance now;
previously, a <type>resource</type> was returned.
</entry>
</row>
<row>
<entry>7.4.0</entry>
<entry>
The behavior of imagecropauto() in the bundled libgd has been synced with
that of system libgd: <constant>IMG_CROP_DEFAULT</constant> no longer falls
back to <constant>IMG_CROP_SIDES</constant> and threshold-cropping now uses
the same algorithm as system libgd.
</entry>
</row>
<row>
<entry>7.4.0</entry>
<entry>
The default value of <parameter>mode</parameter> has been changed to
<constant>IMG_CROP_AUTO</constant>. Formerly, the default value has been
<literal>-1</literal> which corresponds to <constant>IMG_CROP_DEFAULT</constant>,
but passing <literal>-1</literal> is now deprecated.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Proper handling of auto-cropping</title>
<para>
As noted in the return value section, <function>imagecropauto</function>
returns &false; if the whole image
was cropped. In this example we have an image object
<literal>$im</literal> which should be automatically cropped only if there
is something to crop; otherwise we want to proceed with the original image.
</para>
<programlisting role="php">
<![CDATA[
<?php
$cropped = imagecropauto($im, IMG_CROP_DEFAULT);
if ($cropped !== false) { // in case a new image object was returned
imagedestroy($im); // we destroy the original image
$im = $cropped; // and assign the cropped image to $im
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>imagecrop</function></member>
</simplelist>
</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
-->
|
