summaryrefslogtreecommitdiffstats
path: root/devel-docs/libgimp/html/libgimp-gimpimageconvert.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--devel-docs/libgimp/html/libgimp-gimpimageconvert.html317
1 files changed, 317 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpimageconvert.html b/devel-docs/libgimp/html/libgimp-gimpimageconvert.html
new file mode 100644
index 0000000..fd3f650
--- /dev/null
+++ b/devel-docs/libgimp/html/libgimp-gimpimageconvert.html
@@ -0,0 +1,317 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>gimpimageconvert: GIMP Library Reference Manual</title>
+<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
+<link rel="home" href="index.html" title="GIMP Library Reference Manual">
+<link rel="up" href="libgimp-image.html" title="Manipulating Images and their Properties">
+<link rel="prev" href="libgimp-gimpimagecolorprofile.html" title="gimpimagecolorprofile">
+<link rel="next" href="libgimp-gimpimagegrid.html" title="gimpimagegrid">
+<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</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="5"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
+ <a href="#libgimp-gimpimageconvert.description" class="shortcut">Description</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="libgimp-image.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="libgimp-gimpimagecolorprofile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="libgimp-gimpimagegrid.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="libgimp-gimpimageconvert"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="libgimp-gimpimageconvert.top_of_page"></a>gimpimageconvert</span></h2>
+<p>gimpimageconvert — Conversions between RGB, indexed, and grayscale modes.</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="libgimp-gimpimageconvert.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_proto_type">
+<col class="functions_proto_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpimageconvert.html#gimp-image-convert-rgb" title="gimp_image_convert_rgb ()">gimp_image_convert_rgb</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpimageconvert.html#gimp-image-convert-grayscale" title="gimp_image_convert_grayscale ()">gimp_image_convert_grayscale</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpimageconvert.html#gimp-image-convert-indexed" title="gimp_image_convert_indexed ()">gimp_image_convert_indexed</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpimageconvert.html#gimp-image-convert-set-dither-matrix" title="gimp_image_convert_set_dither_matrix ()">gimp_image_convert_set_dither_matrix</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="libgimp-gimpimageconvert.html#gimp-image-convert-precision" title="gimp_image_convert_precision ()">gimp_image_convert_precision</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="libgimp-gimpimageconvert.description"></a><h2>Description</h2>
+<p>Conversions between RGB, indexed, and grayscale modes.</p>
+</div>
+<div class="refsect1">
+<a name="libgimp-gimpimageconvert.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gimp-image-convert-rgb"></a><h3>gimp_image_convert_rgb ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_image_convert_rgb (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</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 Grayscale or Indexed color mode. No
+image content is lost in this process aside from the colormap for an
+indexed image.</p>
+<div class="refsect3">
+<a name="gimp-image-convert-rgb.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>image_ID</p></td>
+<td class="parameter_description"><p>The image.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-image-convert-rgb.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-image-convert-grayscale"></a><h3>gimp_image_convert_grayscale ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_image_convert_grayscale (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>);</pre>
+<p>Convert specified image to grayscale</p>
+<p>This procedure converts the specified image to grayscale. This
+process requires an image in RGB or Indexed color mode.</p>
+<div class="refsect3">
+<a name="gimp-image-convert-grayscale.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>image_ID</p></td>
+<td class="parameter_description"><p>The image.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-image-convert-grayscale.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-image-convert-indexed"></a><h3>gimp_image_convert_indexed ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_image_convert_indexed (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
+ <em class="parameter"><code><a class="link" href="libgimp-gimpenums.html#GimpConvertDitherType" title="enum GimpConvertDitherType"><span class="type">GimpConvertDitherType</span></a> dither_type</code></em>,
+ <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpConvertPaletteType"><span class="type">GimpConvertPaletteType</span></a> palette_type</code></em>,
+ <em class="parameter"><code><span class="type">gint</span> num_cols</code></em>,
+ <em class="parameter"><code><span class="type">gboolean</span> alpha_dither</code></em>,
+ <em class="parameter"><code><span class="type">gboolean</span> remove_unused</code></em>,
+ <em class="parameter"><code>const <span class="type">gchar</span> *palette</code></em>);</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>
+<div class="refsect3">
+<a name="gimp-image-convert-indexed.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>image_ID</p></td>
+<td class="parameter_description"><p>The image.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>dither_type</p></td>
+<td class="parameter_description"><p>The dither type to use.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>palette_type</p></td>
+<td class="parameter_description"><p>The type of palette to use.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>num_cols</p></td>
+<td class="parameter_description"><p>The number of colors to quantize to, ignored unless (palette_type == GIMP_CONVERT_PALETTE_GENERATE).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>alpha_dither</p></td>
+<td class="parameter_description"><p>Dither transparency to fake partial opacity.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>remove_unused</p></td>
+<td class="parameter_description"><p>Remove unused or duplicate color entries from final palette, ignored if (palette_type == GIMP_CONVERT_PALETTE_GENERATE).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>palette</p></td>
+<td class="parameter_description"><p>The name of the custom palette to use, ignored unless (palette_type == GIMP_CONVERT_PALETTE_CUSTOM).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-image-convert-indexed.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-image-convert-set-dither-matrix"></a><h3>gimp_image_convert_set_dither_matrix ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_image_convert_set_dither_matrix (<em class="parameter"><code><span class="type">gint</span> width</code></em>,
+ <em class="parameter"><code><span class="type">gint</span> height</code></em>,
+ <em class="parameter"><code><span class="type">gint</span> matrix_length</code></em>,
+ <em class="parameter"><code>const <span class="type">guint8</span> *matrix</code></em>);</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>
+<div class="refsect3">
+<a name="gimp-image-convert-set-dither-matrix.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>width</p></td>
+<td class="parameter_description"><p>Width of the matrix (0 to reset to default matrix).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>height</p></td>
+<td class="parameter_description"><p>Height of the matrix (0 to reset to default matrix).</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>matrix_length</p></td>
+<td class="parameter_description"><p>The length of 'matrix'.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>matrix</p></td>
+<td class="parameter_description"><p>The matrix -- all values must be &gt;= 1.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-image-convert-set-dither-matrix.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gimp-image-convert-precision"></a><h3>gimp_image_convert_precision ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gimp_image_convert_precision (<em class="parameter"><code><span class="type">gint32</span> image_ID</code></em>,
+ <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpPrecision"><span class="type">GimpPrecision</span></a> precision</code></em>);</pre>
+<p>Convert the image to the specified precision</p>
+<p>This procedure converts the image to the specified precision. Note
+that indexed images cannot be converted and are always in
+GIMP_PRECISION_U8.</p>
+<div class="refsect3">
+<a name="gimp-image-convert-precision.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>image_ID</p></td>
+<td class="parameter_description"><p>The image.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>precision</p></td>
+<td class="parameter_description"><p>The new precision.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="gimp-image-convert-precision.returns"></a><h4>Returns</h4>
+<p> TRUE on success.</p>
+</div>
+<p class="since">Since: <a class="link" href="api-index-2-10.html#api-index-2.10">2.10</a></p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>Generated by GTK-Doc V1.33.1</div>
+</body>
+</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-10 08:39:57 +0000