jpeg2wbmp.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.jpeg2wbmp" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>jpeg2wbmp</refname>
  <refpurpose>Convert JPEG image file to WBMP image file</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>jpeg2wbmp</methodname>
   <methodparam><type>string</type><parameter>jpegname</parameter></methodparam>
   <methodparam><type>string</type><parameter>wbmpname</parameter></methodparam>
   <methodparam><type>int</type><parameter>dest_height</parameter></methodparam>
   <methodparam><type>int</type><parameter>dest_width</parameter></methodparam>
   <methodparam><type>int</type><parameter>threshold</parameter></methodparam>
  </methodsynopsis>
  <para>
   Converts a JPEG file into a WBMP file.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>jpegname</parameter></term>
     <listitem>
      <para>
       Path to JPEG file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>wbmpname</parameter></term>
     <listitem>
      <para>
       Path to destination WBMP file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dest_height</parameter></term>
     <listitem>
      <para>
       Destination image height.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dest_width</parameter></term>
     <listitem>
      <para>
       Destination image width.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>threshold</parameter></term>
     <listitem>
      <para>
       Threshold value, between 0 and 8 (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>jpeg2wbmp</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Path to the target jpeg
$path = './test.jpg';

// Get the image sizes
$image = getimagesize($path);

// Convert image
jpeg2wbmp($path, './test.wbmp', $image[1], $image[0], 5);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>png2wbmp</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
-->