mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
4a91ea0dd0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@239698 c90b9560-bf6c-de11-be94-00142212c4b1
149 lines
3.9 KiB
XML
149 lines
3.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<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");
|
|
imagepng($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>
|
|
</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
|
|
-->
|