151 lines
7.0 KiB
XML
151 lines
7.0 KiB
XML
<?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>gimpconvert</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpconvert</refname><refpurpose>Conversions between RGB, indexed, and grayscale modes.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><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>
|
|
<title>Description</title>
|
|
<para>
|
|
Conversions between RGB, indexed, and grayscale modes.
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="gimp-image-convert-rgb"/>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"/>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"/>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>
|