File: imagecopyresized.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (232 lines) | stat: -rw-r--r-- 6,918 bytes parent folder | download
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
229
230
231
232
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<refentry xml:id="function.imagecopyresized" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imagecopyresized</refname>
  <refpurpose>Copy and resize part of an image</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>imagecopyresized</methodname>
   <methodparam><type>resource</type><parameter>dst_image</parameter></methodparam>
   <methodparam><type>resource</type><parameter>src_image</parameter></methodparam>
   <methodparam><type>int</type><parameter>dst_x</parameter></methodparam>
   <methodparam><type>int</type><parameter>dst_y</parameter></methodparam>
   <methodparam><type>int</type><parameter>src_x</parameter></methodparam>
   <methodparam><type>int</type><parameter>src_y</parameter></methodparam>
   <methodparam><type>int</type><parameter>dst_w</parameter></methodparam>
   <methodparam><type>int</type><parameter>dst_h</parameter></methodparam>
   <methodparam><type>int</type><parameter>src_w</parameter></methodparam>
   <methodparam><type>int</type><parameter>src_h</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>imagecopyresized</function> copies a rectangular
   portion of one image to another image.
   <parameter>dst_image</parameter> is the destination image,
   <parameter>src_image</parameter> is the source image identifier.
  </para>
  <para>
   In other words, <function>imagecopyresized</function> will take an 
   rectangular area from <parameter>src_image</parameter> of width 
   <parameter>src_w</parameter> and height <parameter>src_h</parameter> at 
   position (<parameter>src_x</parameter>,<parameter>src_y</parameter>) 
   and place it in a rectangular area of <parameter>dst_image</parameter> 
   of width <parameter>dst_w</parameter> and height <parameter>dst_h</parameter>
   at position (<parameter>dst_x</parameter>,<parameter>dst_y</parameter>).
  </para>
  <para>
   If the source and destination coordinates and width and heights
   differ, appropriate stretching or shrinking of the image fragment
   will be performed. The coordinates refer to the upper left
   corner. This function can be used to copy regions within the
   same image (if <parameter>dst_image</parameter> is the same as
   <parameter>src_image</parameter>) but if the regions overlap the
   results will be unpredictable.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dst_im</parameter></term>
     <listitem>
      <para>
       Destination image link resource.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_im</parameter></term>
     <listitem>
      <para>
       Source image link resource.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dst_x</parameter></term>
     <listitem>
      <para>
       x-coordinate of destination point.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dst_y</parameter></term>
     <listitem>
      <para>
       y-coordinate of destination point.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_x</parameter></term>
     <listitem>
      <para>
       x-coordinate of source point.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_y</parameter></term>
     <listitem>
      <para>
       y-coordinate of source point.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dst_w</parameter></term>
     <listitem>
      <para>
       Destination width.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dst_h</parameter></term>
     <listitem>
      <para>
       Destination height.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_w</parameter></term>
     <listitem>
      <para>
       Source width.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>src_h</parameter></term>
     <listitem>
      <para>
       Source height.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Resizing an image</title>
    <para>
     This example will display the image at half size.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
// File and new size
$filename = 'test.jpg';
$percent = 0.5;

// Content type
header('Content-type: image/jpeg');

// Get new sizes
list($width, $height) = getimagesize($filename);
$newwidth = $width * $percent;
$newheight = $height * $percent;

// Load
$thumb = imagecreatetruecolor($newwidth, $newheight);
$source = imagecreatefromjpeg($filename);

// Resize
imagecopyresized($thumb, $source, 0, 0, 0, 0, $newwidth, $newheight, $width, $height);

// Output
imagejpeg($thumb);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <mediaobject>
     <imageobject>
      <imagedata fileref="figures/image.imagecopyresized.jpg"/>
     </imageobject>
    </mediaobject>
    <para>
     The image will be output at half size, though better
     quality could be obtained using <function>imagecopyresampled</function>.
    </para>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    There is a problem due to palette image limitations (255+1 colors).
    Resampling or filtering an image commonly needs more colors than 255, a
    kind of approximation is used to calculate the new resampled pixel and its
    color.  With a palette image we try to allocate a new color, if that
    failed, we choose the closest (in theory) computed color.  This is
    not always the closest visual color. That may produce a weird result, like
    blank (or visually blank) images.  To skip this problem, please use a
    truecolor image as a destination image, such as one created by
    <function>imagecreatetruecolor</function>.
   </para>
  </note>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <function>imagecopyresampled</function>
  </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
-->