File: imagetruecolortopalette.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (59 lines) | stat: -rw-r--r-- 2,224 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/image.xml, last change in rev 1.34 -->
  <refentry id="function.imagetruecolortopalette">
   <refnamediv>
    <refname>imagetruecolortopalette</refname>
    <refpurpose>Convert a true color image to a palette image</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</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>
    <para>
     <parameter>dither</parameter> 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>
    <para>
     <parameter>ncolors</parameter> sets the maximum number of colors that
     should be retained in the palette.
    </para>
    &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
-->