Files
gimp/devel-docs/libgimp/html/libgimp-gimpconvert.html
2010-08-11 01:23:08 -04:00

335 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimpconvert</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="prev" href="libgimp-gimpcolor.html" title="gimpcolor">
<link rel="next" href="libgimp-gimpdisplay.html" title="gimpdisplay">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpcolor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpdisplay.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2618840" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2632866" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpconvert"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2618840"></a><span class="refentrytitle">gimpconvert</span>
</h2>
<p>gimpconvert &#8212; Conversions between RGB, indexed, and grayscale modes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpconvert.html#gimp-image-convert-rgb">gimp_image_convert_rgb</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpconvert.html#gimp-image-convert-grayscale">gimp_image_convert_grayscale</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpconvert.html#gimp-image-convert-indexed">gimp_image_convert_indexed</a> (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a class="link" href="libgimp-gimpenums.html#GimpConvertDitherType">GimpConvertDitherType</a> dither_type,
<a class="link" href="libgimp-gimpenums.html#GimpConvertPaletteType">GimpConvertPaletteType</a> palette_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_cols,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> alpha_dither,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> remove_unused,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimpconvert.html#gimp-image-convert-set-dither-matrix">gimp_image_convert_set_dither_matrix</a>
(<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> matrix_length,
const <a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> *matrix);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2632866"></a><h2>Description</h2>
<p>
Conversions between RGB, indexed, and grayscale modes.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2632883"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2632894"></a><h3>
<a name="gimp-image-convert-rgb"></a>gimp_image_convert_rgb ()</h3>
<a class="indexterm" name="id2632905"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_convert_rgb (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<p>
Convert specified image to RGB color
</p>
<p>
This procedure converts the specified image to RGB color. This
process requires an image in RGB or Indexed color mode. No image
content is lost in this process aside from the colormap for an
indexed image.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2633814"></a><h3>
<a name="gimp-image-convert-grayscale"></a>gimp_image_convert_grayscale ()</h3>
<a class="indexterm" name="id2633825"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_convert_grayscale (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID);</pre>
<p>
Convert specified image to grayscale (256 intensity levels)
</p>
<p>
This procedure converts the specified image to grayscale with 8 bits
per pixel (256 intensity levels). This process requires an image in
RGB or Indexed color mode.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2633892"></a><h3>
<a name="gimp-image-convert-indexed"></a>gimp_image_convert_indexed ()</h3>
<a class="indexterm" name="id2633904"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_convert_indexed (<a
href="../glib/glib-Basic-Types.html#gint32"
>gint32</a> image_ID,
<a class="link" href="libgimp-gimpenums.html#GimpConvertDitherType">GimpConvertDitherType</a> dither_type,
<a class="link" href="libgimp-gimpenums.html#GimpConvertPaletteType">GimpConvertPaletteType</a> palette_type,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_cols,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> alpha_dither,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> remove_unused,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette);</pre>
<p>
Convert specified image to and Indexed image
</p>
<p>
This procedure converts the specified image to 'indexed' color. This
process requires an image in RGB or Grayscale mode. 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).</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image_ID</code></em>&#160;:</span></p></td>
<td> The image.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dither_type</code></em>&#160;:</span></p></td>
<td> The dither type to use.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette_type</code></em>&#160;:</span></p></td>
<td> The type of palette to use.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_cols</code></em>&#160;:</span></p></td>
<td> The number of colors to quantize to, ignored unless (palette_type == GIMP_MAKE_PALETTE).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>alpha_dither</code></em>&#160;:</span></p></td>
<td> Dither transparency to fake partial opacity.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>remove_unused</code></em>&#160;:</span></p></td>
<td> Remove unused or duplicate color entries from final palette, ignored if (palette_type == GIMP_MAKE_PALETTE).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette</code></em>&#160;:</span></p></td>
<td> The name of the custom palette to use, ignored unless (palette_type == GIMP_CUSTOM_PALETTE).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631425"></a><h3>
<a name="gimp-image-convert-set-dither-matrix"></a>gimp_image_convert_set_dither_matrix ()</h3>
<a class="indexterm" name="id2631438"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_image_convert_set_dither_matrix
(<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> matrix_length,
const <a
href="../glib/glib-Basic-Types.html#guint8"
>guint8</a> *matrix);</pre>
<p>
Set dither matrix for conversion to indexed
</p>
<p>
This procedure sets the dither matrix used when converting images to
INDEXED mode with positional dithering.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> Width of the matrix (0 to reset to default matrix).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> Height of the matrix (0 to reset to default matrix).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix_length</code></em>&#160;:</span></p></td>
<td> The length of 'matrix'.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em>&#160;:</span></p></td>
<td> The matrix -- all values must be &gt;= 1.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>