php-doc-en/reference/image/functions/image2wbmp.xml
2005-08-10 04:48:11 +00:00

80 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/image.xml, last change in rev 1.61 -->
<refentry id="function.image2wbmp">
<refnamediv>
<refname>image2wbmp</refname>
<refpurpose>Output image to browser or file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>image2wbmp</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>threshold</parameter></methodparam>
</methodsynopsis>
<para>
<function>image2wbmp</function> creates the
<acronym>WBMP</acronym> file in filename from the image
<parameter>image</parameter>. The <parameter>image</parameter> argument
is the return from one of the image create functions, such as
<function>imagecreatetruecolor</function>.
</para>
<para>
The filename argument is optional, and if left off, the raw image
stream will be output directly.
By sending an <acronym>image/vnd.wap.wbmp</acronym> content-type
using <function>header</function>, you can create
a PHP script that outputs WBMP images directly.
</para>
<para>
<example>
<title><function>image2wbmp</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$file = 'php.png';
$image = imagecreatefrompng($file);
header('Content-type: ' . image_type_to_mime_type(IMAGETYPE_WBMP));
image2wbmp($image); // output the stream directly
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
WBMP support is only available if PHP was compiled
against GD-1.8 or later.
</para>
</note>
<para>
See also <function>imagewbmp</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
-->