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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imagescale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imagescale</refname>
<refpurpose>Scale an image using the given new width and height</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>GdImage</type><type>false</type></type><methodname>imagescale</methodname>
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>height</parameter><initializer>-1</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>IMG_BILINEAR_FIXED</constant></initializer></methodparam>
</methodsynopsis>
<para>
<function>imagescale</function> scales an image using the given
interpolation algorithm.
</para>
<note>
<para>
Unlike many of other image functions, <function>imagescale</function> does
not modify the passed <parameter>image</parameter>; instead, a
<emphasis>new</emphasis> image is returned.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The width to scale the image to.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
The height to scale the image to. If omitted or negative, the aspect
ratio will be preserved.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
One of <constant>IMG_NEAREST_NEIGHBOUR</constant>,
<constant>IMG_BILINEAR_FIXED</constant>,
<constant>IMG_BICUBIC</constant>,
<constant>IMG_BICUBIC_FIXED</constant> or anything else (will use two
pass).
<note>
<simpara>
<constant>IMG_WEIGHTED4</constant> is not yet supported.
</simpara>
</note>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return the scaled image object on success&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <classname>ValueError</classname> if <parameter>width</parameter>
or <parameter>height</parameter> would cause over-/underflow.
</simpara>
<simpara>
Throws a <classname>ValueError</classname> if <parameter>mode</parameter> is invalid.
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.4.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if <parameter>width</parameter>
or <parameter>height</parameter> would cause over-/underflow.
</entry>
</row>
<row>
<entry>8.4.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if <parameter>mode</parameter> is invalid.
</entry>
</row>
<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>
&gd.changelog.image-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>imagecopyresized</function></member>
<member><function>imagecopyresampled</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
-->
|
