File: imagecopyresampled.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (165 lines) | stat: -rw-r--r-- 5,206 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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/image.xml, last change in rev 1.36 -->
 <refentry id="function.imagecopyresampled">
  <refnamediv>
   <refname>imagecopyresampled</refname>
   <refpurpose>Copy and resize part of an image with resampling</refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
    <methodsynopsis>
     <type>bool</type><methodname>imagecopyresampled</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>imagecopyresampled</function> copies a rectangular
    portion of one image to another image, smoothly interpolating pixel
    values so that, in particular, reducing the size of an image still
    retains a great deal of clarity.
    &return.success;
   </para>
   <para>
    <parameter>dst_image</parameter> is the destination image,
    <parameter>src_image</parameter> is the source image identifier.  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>
   <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>
   &note.gd.2;
  </refsect1>

  <refsect1>
   &reftitle.examples;

   <para>
    <example>
     <title>Simple example</title>
     <para>
      This example will resample an image to half its original size.
     </para>
     <programlisting role="php">
<![CDATA[
<?php
// The file
$filename = 'test.jpg';
$percent = 0.5;

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

// Get new dimensions
list($width, $height) = getimagesize($filename);
$new_width = $width * $percent;
$new_height = $height * $percent;

// Resample
$image_p = imagecreatetruecolor($new_width, $new_height);
$image = imagecreatefromjpeg($filename);
imagecopyresampled($image_p, $image, 0, 0, 0, 0, $new_width, $new_height, $width, $height);

// Output
imagejpeg($image_p, null, 100);
?>
]]>
     </programlisting>
    </example>
   </para>

   <para>
    <example>
     <title>Resampling an image proportionally</title>
     <para>
      This example will display an image with the maximum width,
      or height, of 200 pixels.
     </para>
     <programlisting role="php">
<![CDATA[
<?php
// The file
$filename = 'test.jpg';

// Set a maximum height and width
$width = 200;
$height = 200;

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

// Get new dimensions
list($width_orig, $height_orig) = getimagesize($filename);

if ($width && ($width_orig < $height_orig)) {
    $width = ($height / $height_orig) * $width_orig;
} else {
    $height = ($width / $width_orig) * $height_orig;
}

// Resample
$image_p = imagecreatetruecolor($width, $height);
$image = imagecreatefromjpeg($filename);
imagecopyresampled($image_p, $image, 0, 0, 0, 0, $width, $height, $width_orig, $height_orig);

// Output
imagejpeg($image_p, null, 100);
?>
]]>
     </programlisting>
    </example>
   </para>
  </refsect1>

  <refsect1>
   &reftitle.seealso;
   <para>
    <function>imagecopyresized</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
-->