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 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpconvert">
<refmeta>
<refentrytitle role="top_of_page">gimpconvert</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpconvert</refname>
<refpurpose>Conversions between RGB, indexed, and grayscale modes.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-convert-rgb">gimp_image_convert_rgb</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-convert-grayscale">gimp_image_convert_grayscale</link> (<link linkend="gint32">gint32</link> image_ID);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-image-convert-indexed">gimp_image_convert_indexed</link> (<link linkend="gint32">gint32</link> image_ID,
<link linkend="GimpConvertDitherType">GimpConvertDitherType</link> dither_type,
<link linkend="GimpConvertPaletteType">GimpConvertPaletteType</link> palette_type,
<link linkend="gint">gint</link> num_cols,
<link linkend="gboolean">gboolean</link> alpha_dither,
<link linkend="gboolean">gboolean</link> remove_unused,
const <link linkend="gchar">gchar</link> *palette);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Conversions between RGB, indexed, and grayscale modes.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-image-convert-rgb" role="function"/>gimp_image_convert_rgb ()</title>
<indexterm><primary>gimp_image_convert_rgb</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_convert_rgb (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Convert specified image to RGB color
</para>
<para>
This procedure converts the specified image to RGB color. This
process requires an image of type GIMP_GRAY or GIMP_INDEXED. No
image content is lost in this process aside from the colormap for an
indexed image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-image-convert-grayscale" role="function"/>gimp_image_convert_grayscale ()</title>
<indexterm><primary>gimp_image_convert_grayscale</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_convert_grayscale (<link linkend="gint32">gint32</link> image_ID);</programlisting>
<para>
Convert specified image to grayscale (256 intensity levels)
</para>
<para>
This procedure converts the specified image to grayscale with 8 bits
per pixel (256 intensity levels). This process requires an image of
type GIMP_RGB or GIMP_INDEXED.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-image-convert-indexed" role="function"/>gimp_image_convert_indexed ()</title>
<indexterm><primary>gimp_image_convert_indexed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_image_convert_indexed (<link linkend="gint32">gint32</link> image_ID,
<link linkend="GimpConvertDitherType">GimpConvertDitherType</link> dither_type,
<link linkend="GimpConvertPaletteType">GimpConvertPaletteType</link> palette_type,
<link linkend="gint">gint</link> num_cols,
<link linkend="gboolean">gboolean</link> alpha_dither,
<link linkend="gboolean">gboolean</link> remove_unused,
const <link linkend="gchar">gchar</link> *palette);</programlisting>
<para>
Convert specified image to and Indexed image
</para>
<para>
This procedure converts the specified image to 'indexed' color. This
process requires an image of type GIMP_GRAY or GIMP_RGB. The
'palette_type' specifies what kind of palette to use, A type of '0'
means to use an optimal palette of 'num_cols' generated from the
colors in the image. A type of '1' means to re-use the previous
palette (not currently implemented). A type of '2' means to use the
so-called WWW-optimized palette. Type '3' means to use only black
and white colors. A type of '4' means to use a palette from the gimp
palettes directories. The 'dither type' specifies what kind of
dithering to use. '0' means no dithering, '1' means standard
Floyd-Steinberg error diffusion, '2' means Floyd-Steinberg error
diffusion with reduced bleeding, '3' means dithering based on pixel
location ('Fixed' dithering).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_ID</parameter> :</term>
<listitem><simpara> The image.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dither_type</parameter> :</term>
<listitem><simpara> The dither type to use.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>palette_type</parameter> :</term>
<listitem><simpara> The type of palette to use.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_cols</parameter> :</term>
<listitem><simpara> The number of colors to quantize to, ignored unless (palette_type == GIMP_MAKE_PALETTE).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>alpha_dither</parameter> :</term>
<listitem><simpara> Dither transparency to fake partial opacity.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>remove_unused</parameter> :</term>
<listitem><simpara> Remove unused or duplicate colour entries from final palette, ignored if (palette_type == GIMP_MAKE_PALETTE).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>palette</parameter> :</term>
<listitem><simpara> The name of the custom palette to use, ignored unless (palette_type == GIMP_CUSTOM_PALETTE).
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|