php-doc-en/reference/image/functions/image2wbmp.xml
Nikola Smolenski d732584196 - New entities for GD image library
- Capitalize Content-Type in all affected files as in RFC 2616 (and IMO prettier)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@309972 c90b9560-bf6c-de11-be94-00142212c4b1
2011-04-05 15:03:52 +00:00

110 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.image2wbmp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>image2wbmp</refname>
<refpurpose>&gd.image.output;</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</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> outputs or save a <acronym>WBMP</acronym>
version of 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>
Path to the saved file. If not given, the raw image stream will be
outputted directly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>threshold</parameter></term>
<listitem>
<para>
Threshold value, between 0 and 255 (inclusive).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<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
imagedestroy($image);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
WBMP support is only available if PHP was compiled against GD-1.8 or
later.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imagewbmp</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:"~/.phpdoc/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
-->