php-doc-en/reference/image/functions/imagewbmp.xml
2007-07-13 14:45:23 +00:00

96 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.imagewbmp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imagewbmp</refname>
<refpurpose>Output image to browser or file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagewbmp</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>foreground</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagewbmp</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>
The path to save the file to. If not set or &null;, the raw image stream
will be outputted directly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>foreground</parameter></term>
<listitem>
<para>
You can set the foreground color with this parameter by setting an
identifier obtained from <function>imagecolorallocate</function>.
The default foreground color is black.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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>image2wbmp</function></member>
<member><function>imagepng</function></member>
<member><function>imagegif</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
-->