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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.15 $ -->
<refentry xml:id="function.imagepng" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagepng</refname>
<refpurpose>Output a PNG image to either the browser or a file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagepng</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>quality</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>filters</parameter></methodparam>
</methodsynopsis>
<para>
Outputs or saves a <acronym>PNG</acronym> image from the given
<parameter>image</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The path to save the file to. If not set or &null;, the raw image stream
will be outputted directly.
</para>
<note>
<para>
&null; is invalid if the <parameter>quality</parameter> and
<parameter>filters</parameter> arguments are not used.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>quality</parameter></term>
<listitem>
<para>
Compression level: from 0 (no compression) to 9.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filters</parameter></term>
<listitem>
<para>
Allows reducing the PNG file size. It is a bitmask field which may be
set to any combination of the <literal>PNG_FILTER_XXX</literal>
constants. <constant>PNG_NO_FILTER</constant> or
<constant>PNG_ALL_FILTERS</constant> may also be used to respectively
disable or activate all filters.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.1.3</entry>
<entry>
Added the <parameter>filters</parameter> parameter.
</entry>
</row>
<row>
<entry>5.1.2</entry>
<entry>
Added the <parameter>quality</parameter> parameter.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
<?php
$im = imagecreatefrompng("test.png");
header('Content-type: image/png');
imagepng($im);
imagedestroy($im);
?>
]]>
</programlisting>
</informalexample>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagegif</function></member>
<member><function>imagewbmp</function></member>
<member><function>imagejpeg</function></member>
<member><function>imagetypes</function></member>
<member><function>imagesavealpha</function></member>
</simplelist>
</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
-->
|