← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpconvert.xml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimpconvert.xml
1
 
<?xml version="1.0" encoding="UTF-8" ?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
 
 
5
 
<refentry id="libgimp-gimpconvert">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="libgimp-gimpconvert.top_of_page">gimpconvert</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimpconvert</refname>
14
 
<refpurpose>Conversions between RGB, indexed, and grayscale modes.</refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="libgimp-gimpconvert.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-convert-rgb">gimp_image_convert_rgb</link>              (<link linkend="gint32">gint32</link> image_ID);
22
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-convert-grayscale">gimp_image_convert_grayscale</link>        (<link linkend="gint32">gint32</link> image_ID);
23
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-convert-indexed">gimp_image_convert_indexed</link>          (<link linkend="gint32">gint32</link> image_ID,
24
 
                                                         <link linkend="GimpConvertDitherType">GimpConvertDitherType</link> dither_type,
25
 
                                                         <link linkend="GimpConvertPaletteType">GimpConvertPaletteType</link> palette_type,
26
 
                                                         <link linkend="gint">gint</link> num_cols,
27
 
                                                         <link linkend="gboolean">gboolean</link> alpha_dither,
28
 
                                                         <link linkend="gboolean">gboolean</link> remove_unused,
29
 
                                                         const <link linkend="gchar">gchar</link> *palette);
30
 
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-image-convert-set-dither-matrix">gimp_image_convert_set_dither_matrix</link>
31
 
                                                        (<link linkend="gint">gint</link> width,
32
 
                                                         <link linkend="gint">gint</link> height,
33
 
                                                         <link linkend="gint">gint</link> matrix_length,
34
 
                                                         const <link linkend="guint8">guint8</link> *matrix);
35
 
</synopsis>
36
 
</refsynopsisdiv>
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
<refsect1 id="libgimp-gimpconvert.description" role="desc">
47
 
<title role="desc.title">Description</title>
48
 
<para>
49
 
Conversions between RGB, indexed, and grayscale modes.
50
 
</para>
51
 
</refsect1>
52
 
 
53
 
<refsect1 id="libgimp-gimpconvert.details" role="details">
54
 
<title role="details.title">Details</title>
55
 
<refsect2 id="gimp-image-convert-rgb" role="function">
56
 
<title>gimp_image_convert_rgb ()</title>
57
 
<indexterm zone="gimp-image-convert-rgb"><primary sortas="gimp_image_convert_rgb">gimp_image_convert_rgb</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_convert_rgb              (<link linkend="gint32">gint32</link> image_ID);</programlisting>
58
 
<para>
59
 
Convert specified image to RGB color
60
 
</para>
61
 
<para>
62
 
This procedure converts the specified image to RGB color. This
63
 
process requires an image in Grayscale or Indexed color mode. No
64
 
image content is lost in this process aside from the colormap for an
65
 
indexed image.</para>
66
 
<para>
67
 
</para><variablelist role="params">
68
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
69
 
<listitem><simpara> The image.
70
 
</simpara></listitem></varlistentry>
71
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
72
 
</simpara></listitem></varlistentry>
73
 
</variablelist></refsect2>
74
 
<refsect2 id="gimp-image-convert-grayscale" role="function">
75
 
<title>gimp_image_convert_grayscale ()</title>
76
 
<indexterm zone="gimp-image-convert-grayscale"><primary sortas="gimp_image_convert_grayscale">gimp_image_convert_grayscale</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_convert_grayscale        (<link linkend="gint32">gint32</link> image_ID);</programlisting>
77
 
<para>
78
 
Convert specified image to grayscale (256 intensity levels)
79
 
</para>
80
 
<para>
81
 
This procedure converts the specified image to grayscale with 8 bits
82
 
per pixel (256 intensity levels). This process requires an image in
83
 
RGB or Indexed color mode.</para>
84
 
<para>
85
 
</para><variablelist role="params">
86
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
87
 
<listitem><simpara> The image.
88
 
</simpara></listitem></varlistentry>
89
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
90
 
</simpara></listitem></varlistentry>
91
 
</variablelist></refsect2>
92
 
<refsect2 id="gimp-image-convert-indexed" role="function">
93
 
<title>gimp_image_convert_indexed ()</title>
94
 
<indexterm zone="gimp-image-convert-indexed"><primary sortas="gimp_image_convert_indexed">gimp_image_convert_indexed</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_convert_indexed          (<link linkend="gint32">gint32</link> image_ID,
95
 
                                                         <link linkend="GimpConvertDitherType">GimpConvertDitherType</link> dither_type,
96
 
                                                         <link linkend="GimpConvertPaletteType">GimpConvertPaletteType</link> palette_type,
97
 
                                                         <link linkend="gint">gint</link> num_cols,
98
 
                                                         <link linkend="gboolean">gboolean</link> alpha_dither,
99
 
                                                         <link linkend="gboolean">gboolean</link> remove_unused,
100
 
                                                         const <link linkend="gchar">gchar</link> *palette);</programlisting>
101
 
<para>
102
 
Convert specified image to and Indexed image
103
 
</para>
104
 
<para>
105
 
This procedure converts the specified image to 'indexed' color. This
106
 
process requires an image in RGB or Grayscale mode. The
107
 
'palette_type' specifies what kind of palette to use, A type of '0'
108
 
means to use an optimal palette of 'num_cols' generated from the
109
 
colors in the image. A type of '1' means to re-use the previous
110
 
palette (not currently implemented). A type of '2' means to use the
111
 
so-called WWW-optimized palette. Type '3' means to use only black
112
 
and white colors. A type of '4' means to use a palette from the gimp
113
 
palettes directories. The 'dither type' specifies what kind of
114
 
dithering to use. '0' means no dithering, '1' means standard
115
 
Floyd-Steinberg error diffusion, '2' means Floyd-Steinberg error
116
 
diffusion with reduced bleeding, '3' means dithering based on pixel
117
 
location ('Fixed' dithering).</para>
118
 
<para>
119
 
</para><variablelist role="params">
120
 
<varlistentry><term><parameter>image_ID</parameter>&#160;:</term>
121
 
<listitem><simpara> The image.
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><parameter>dither_type</parameter>&#160;:</term>
124
 
<listitem><simpara> The dither type to use.
125
 
</simpara></listitem></varlistentry>
126
 
<varlistentry><term><parameter>palette_type</parameter>&#160;:</term>
127
 
<listitem><simpara> The type of palette to use.
128
 
</simpara></listitem></varlistentry>
129
 
<varlistentry><term><parameter>num_cols</parameter>&#160;:</term>
130
 
<listitem><simpara> The number of colors to quantize to, ignored unless (palette_type == GIMP_MAKE_PALETTE).
131
 
</simpara></listitem></varlistentry>
132
 
<varlistentry><term><parameter>alpha_dither</parameter>&#160;:</term>
133
 
<listitem><simpara> Dither transparency to fake partial opacity.
134
 
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>remove_unused</parameter>&#160;:</term>
136
 
<listitem><simpara> Remove unused or duplicate color entries from final palette, ignored if (palette_type == GIMP_MAKE_PALETTE).
137
 
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><parameter>palette</parameter>&#160;:</term>
139
 
<listitem><simpara> The name of the custom palette to use, ignored unless (palette_type == GIMP_CUSTOM_PALETTE).
140
 
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
142
 
</simpara></listitem></varlistentry>
143
 
</variablelist></refsect2>
144
 
<refsect2 id="gimp-image-convert-set-dither-matrix" role="function" condition="since:GIMP 2.4">
145
 
<title>gimp_image_convert_set_dither_matrix ()</title>
146
 
<indexterm zone="gimp-image-convert-set-dither-matrix" role="GIMP 2.4"><primary sortas="gimp_image_convert_set_dither_matrix">gimp_image_convert_set_dither_matrix</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_image_convert_set_dither_matrix
147
 
                                                        (<link linkend="gint">gint</link> width,
148
 
                                                         <link linkend="gint">gint</link> height,
149
 
                                                         <link linkend="gint">gint</link> matrix_length,
150
 
                                                         const <link linkend="guint8">guint8</link> *matrix);</programlisting>
151
 
<para>
152
 
Set dither matrix for conversion to indexed
153
 
</para>
154
 
<para>
155
 
This procedure sets the dither matrix used when converting images to
156
 
INDEXED mode with positional dithering.</para>
157
 
<para>
158
 
</para><variablelist role="params">
159
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
160
 
<listitem><simpara> Width of the matrix (0 to reset to default matrix).
161
 
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><parameter>height</parameter>&#160;:</term>
163
 
<listitem><simpara> Height of the matrix (0 to reset to default matrix).
164
 
</simpara></listitem></varlistentry>
165
 
<varlistentry><term><parameter>matrix_length</parameter>&#160;:</term>
166
 
<listitem><simpara> The length of 'matrix'.
167
 
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><parameter>matrix</parameter>&#160;:</term>
169
 
<listitem><simpara> The matrix -- all values must be &gt;= 1.
170
 
</simpara></listitem></varlistentry>
171
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE on success.
172
 
 
173
 
</simpara></listitem></varlistentry>
174
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
175
 
 
176
 
</refsect1>
177
 
 
178
 
 
179
 
 
180
 
 
181
 
</refentry>