php-doc-en/reference/image/functions/imagetruecolortopalette.xml
Mehdi Achour 13b0b6f8ad gd: switch to new docstyle
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227185 c90b9560-bf6c-de11-be94-00142212c4b1
2007-01-14 03:15:21 +00:00

84 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id="function.imagetruecolortopalette">
<refnamediv>
<refname>imagetruecolortopalette</refname>
<refpurpose>Convert a true color image to a palette image</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imagetruecolortopalette</methodname>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
<methodparam><type>bool</type><parameter>dither</parameter></methodparam>
<methodparam><type>int</type><parameter>ncolors</parameter></methodparam>
</methodsynopsis>
<para>
<function>imagetruecolortopalette</function> converts a truecolor image
to a palette image. The code for this function was originally drawn from
the Independent JPEG Group library code, which is excellent. The code
has been modified to preserve as much alpha channel information as
possible in the resulting palette, in addition to preserving colors as
well as possible. This does not work as well as might be hoped. It is
usually best to simply produce a truecolor output image instead, which
guarantees the highest output quality.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&gd.image.description;
<varlistentry>
<term><parameter>dither</parameter></term>
<listitem>
<para>
Indicates if the image should be dithered - if it is &true; then
dithering will be used which will result in a more speckled image but
with better color approximation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>ncolors</parameter></term>
<listitem>
<para>
Sets the maximum number of colors that should be retained in the palette.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.gd.2;
</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
-->