reference/image/functions/imagepng.xml
593ea510e853ff034e03f78a4be0daa41661c9d4
593ea510e853ff034e03f78a4be0daa41661c9d4
...
...
@@ -9,10 +9,10 @@
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
11
<type>bool</type><methodname>imagepng</methodname>
12
-
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
13
-
<methodparam choice="opt"><type>mixed</type><parameter>to</parameter></methodparam>
14
-
<methodparam choice="opt"><type>int</type><parameter>quality</parameter></methodparam>
15
-
<methodparam choice="opt"><type>int</type><parameter>filters</parameter></methodparam>
12
+
<methodparam><type>GdImage</type><parameter>image</parameter></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>resource</type><type>string</type><type>null</type></type><parameter>file</parameter><initializer>&null;</initializer></methodparam>
14
+
<methodparam choice="opt"><type>int</type><parameter>quality</parameter><initializer>-1</initializer></methodparam>
15
+
<methodparam choice="opt"><type>int</type><parameter>filters</parameter><initializer>-1</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>
18
18
Outputs or saves a <acronym>PNG</acronym> image from the given
...
...
@@ -25,7 +25,7 @@
25
25
<variablelist>
26
26
&gd.image.description;
27
27
<varlistentry>
28
-
<term><parameter>to</parameter></term>
28
+
<term><parameter>file</parameter></term>
29
29
<listitem>
30
30
<para>&gd.image.path;</para>
31
31
<note>
...
...
@@ -41,6 +41,8 @@
41
41
<listitem>
42
42
<para>
43
43
Compression level: from 0 (no compression) to 9.
44
+
The default (<literal>-1</literal>) uses the zlib compression default.
45
+
For more information see the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&url.zlib.manual;">zlib manual</link>.
44
46
</para>
45
47
</listitem>
46
48
</varlistentry>
...
...
@@ -53,7 +55,13 @@
53
55
constants. <constant>PNG_NO_FILTER</constant> or
54
56
<constant>PNG_ALL_FILTERS</constant> may also be used to respectively
55
57
disable or activate all filters.
58
+
The default value (<literal>-1</literal>) disables filtering.
56
59
</para>
60
+
<caution>
61
+
<simpara>
62
+
The <parameter>filters</parameter> parameter is ignored by system libgd.
63
+
</simpara>
64
+
</caution>
57
65
</listitem>
58
66
</varlistentry>
59
67
</variablelist>
...
...
@@ -64,43 +72,24 @@
64
72
<para>
65
73
&return.success;
66
74
</para>
75
+
&gd.return.trueonerror;
67
76
</refsect1>
68
77
69
78
<refsect1 role="changelog">
70
79
&reftitle.changelog;
71
-
<para>
72
-
<informaltable>
73
-
<tgroup cols="2">
74
-
<thead>
75
-
<row>
76
-
<entry>&Version;</entry>
77
-
<entry>&Description;</entry>
78
-
</row>
79
-
</thead>
80
-
<tbody>
81
-
<row>
82
-
<entry>5.4.0</entry>
83
-
<entry>
84
-
Added support for passing a stream <type>resource</type> to
85
-
<parameter>to</parameter>.
86
-
</entry>
87
-
</row>
88
-
<row>
89
-
<entry>5.1.3</entry>
90
-
<entry>
91
-
Added the <parameter>filters</parameter> parameter.
92
-
</entry>
93
-
</row>
94
-
<row>
95
-
<entry>5.1.2</entry>
96
-
<entry>
97
-
Added the <parameter>quality</parameter> parameter.
98
-
</entry>
99
-
</row>
100
-
</tbody>
101
-
</tgroup>
102
-
</informaltable>
103
-
</para>
80
+
<informaltable>
81
+
<tgroup cols="2">
82
+
<thead>
83
+
<row>
84
+
<entry>&Version;</entry>
85
+
<entry>&Description;</entry>
86
+
</row>
87
+
</thead>
88
+
<tbody>
89
+
&gd.changelog.image-param;
90
+
</tbody>
91
+
</tgroup>
92
+
</informaltable>
104
93
</refsect1>
105
94
106
95
<refsect1 role="examples">
...
...
@@ -124,18 +113,15 @@ imagedestroy($im);
124
113
</refsect1>
125
114
<refsect1 role="seealso">
126
115
&reftitle.seealso;
127
-
<para>
128
-
<simplelist>
129
-
<member><function>imagegif</function></member>
130
-
<member><function>imagewbmp</function></member>
131
-
<member><function>imagejpeg</function></member>
132
-
<member><function>imagetypes</function></member>
133
-
<member><function>imagesavealpha</function></member>
134
-
</simplelist>
135
-
</para>
116
+
<simplelist>
117
+
<member><function>imagegif</function></member>
118
+
<member><function>imagewbmp</function></member>
119
+
<member><function>imagejpeg</function></member>
120
+
<member><function>imagetypes</function></member>
121
+
<member><function>imagesavealpha</function></member>
122
+
</simplelist>
136
123
</refsect1>
137
124
</refentry>
138
-
139
125
<!-- Keep this comment at the end of the file
140
126
Local variables:
141
127
mode: sgml
142
128