Debian Codegraph @

upstream/mageia-cauldron/man1/pampaintspill.1

raw
1 \
2 .\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
3 .\" Do not hand-hack it! If you have bug fixes or improvements, please find
4 .\" the corresponding HTML page on the Netpbm website, generate a patch
5 .\" against that, and send it to the Netpbm maintainer.
6 .TH "Pampaintspill User Manual" 0 "02 November 2021" "netpbm documentation"
7
8 .SH NAME
9 .PP
10 pampaintspill - smoothly spill colors into the background
11
12 .UN synopsis
13 .SH SYNOPSIS
14 .PP
15 \fBpampaintspill\fP
16 [\fB--bgcolor\fP=\fIcolor\fP]
17 [\fB--wrap\fP]
18 [\fB--all\fP]
19 [\fB--downsample\fP=\fInumber\fP]
20 [\fB--near\fP=\fInumber\fP]
21 [\fB--power\fP=\fInumber\fP] [\fIfilename\fP]
22 [\fB-randomseed=\fP\fIinteger\fP]
23 .PP
24 Minimum unique abbreviations of option are acceptable. You may use
25 double hyphens instead of single hyphen to denote options. You may use
26 white space in place of the equals sign to separate an option name
27 from its value.
28
29 .UN description
30 .SH DESCRIPTION
31 .PP
32 This program is part of
33 .BR "Netpbm" (1)\c
34 \&.
35 .PP
36 \fBpampaintspill\fP produces a smooth color gradient from all of the
37 non-background-colored pixels in an input image, effectively "spilling
38 paint" onto the background. \fBpampaintspill\fP is similar to
39 \fBpamgradient\fP but differs in the following characteristics:
40
41
42 .IP \(bu
43 \fBpampaintspill\fP accepts any number of paint
44 sources (non-background-colored pixels), which can lie anywhere
45 on the canvas. \fBpamgradient\fP accepts exactly
46 four paint sources, one in each corner of the image.
47
48 .IP \(bu
49 \fBpampaintspill\fP requires an input image while
50 \fBpamgradient\fP generates a new image from
51 scratch.
52
53 .IP \(bu
54 \fBpampaintspill\fP can produce tileable output and
55 can control how tightly the gradient colors bind to their source
56 pixels.
57
58 .PP
59 Results are generally best when the input image contains just a few, crisp
60 spots of color. Use your drawing program's pencil tool - as opposed to a
61 paintbrush or airbrush tool - with a small nib.
62
63 .UN options
64 .SH OPTIONS
65 .PP
66 In addition to the options common to all programs based on libnetpbm
67 (most notably \fB-quiet\fP, see
68 .UR index.html#commonoptions
69 Common Options
70 .UE
71 \&), \fBpampaintspill\fP recognizes the following
72 command line options:
73
74
75 .TP
76 \fB--bgcolor\fP=\fIcolor\fP
77
78 Explicitly specify the background color. \fIcolor\fP can be
79 specified using any of the formats accepted by the
80 .UR libnetpbm_image.html#colorname
81 \f(CWpnm_parsecolor()\fP library routine
82 .UE
83 \& such as \f(CWred\fP or \f(CW#ff0000\fP. If
84 \fB--bgcolor\fP is not specified, \fBpampaintspill\fP makes an
85 educated guess about the background color based on the colors in the
86 image's corners.
87
88 .TP
89 \fB--wrap\fP
90
91 Allow gradients to wrap around image borders. That is, colors
92 that spill off the right side of the image reappear on the left side of
93 the image and likewise for left/right, top/bottom, and
94 bottom/top. \fB--wrap\fP makes images tileable, which is nice for
95 producing desktop backgrounds.
96
97 .TP
98 \fB--all\fP
99
100 Recolor all pixels, not just background pixels. Normally,
101 non-background-colored pixels in the input image appear unmodified in
102 the output image. With \fB--all\fP, \fIall\fP pixels are colored
103 based on their distance from all of the (other) non-background-colored
104 pixels.
105
106 .TP
107 \fB--downsample\fP=\fInumber\fP
108
109 Ignore all but \fInumber\fP non-background-colored pixels.
110 When a large number of pixels in the input image differ in color from
111 the background, \fBpampaintspill\fP runs very slowly. The
112 \fB--downsample\fP option randomly selects a given number of colored
113 pixels to use as paint sources for the gradients and ignores the rest,
114 thereby trading off image quality for speed of execution.
115
116 .TP
117 \fB--near\fP=\fInumber\fP
118
119 Consider only the nearest \fInumber\fP paint sources when computing
120 a pixel's new color. The default is to consider all paint sources.
121 In most cases, \fInumber\fP should be fairly small, or its impact
122 will be minimal and execution time will increase unnecessarily. A
123 value of 1 produces a coloring that looks a lot like a Voronoi
124 diagram.
125 .sp
126 This option was new in Netpbm 10.97 (December 2021).
127
128 .TP
129 \fB--power\fP=\fInumber\fP
130
131 Control how color intensity changes as a function of the
132 distance from a paint source. The default value for \fInumber\fP is
133 -2.0, which means that intensity drops (because of the minus sign) with
134 the square (because of the 2.0) of the distance from each paint
135 source. -2.0 generally works well in practice, but other values can be
136 specified for various special effects. With very small numbers of paint
137 sources, -1.0 may produce subtler gradients, but these get muddier as
138 the number of paint sources increases. Positive numbers (e.g., 1.0 and
139 2.0) make the paint sources stand out in the output image by pushing the
140 gradients away from them.
141
142 .TP
143 \fB-randomseed=\fP\fIinteger\fP
144
145 This is the seed fodr the random number generator that generates the
146 pixels.
147 .sp
148 Use this to ensure you get the same image on separate invocations.
149 .sp
150 This option was new in Netpbm 10.94 (March 2021).
151
152
153
154 .UN seealso
155 .SH SEE ALSO
156
157
158 .IP \(bu
159 .BR "\fBpamgradient\fP" (1)\c
160 \&
161 .IP \(bu
162 .BR "\fBppmmake\fP" (1)\c
163 \&,
164 .IP \(bu
165 .BR "\fBppmrainbow\fP" (1)\c
166 \&,
167 .IP \(bu
168 .BR "\fBpgmramp\fP" (1)\c
169 \&,
170 .IP \(bu
171 .BR "\fBppmpat\fP" (1)\c
172 \&,
173 .IP \(bu
174 .BR "\fBpam\fP" (1)\c
175 \&
176
177
178 .UN history
179 .SH HISTORY
180 .PP
181 \fBpampaintspill\fP was new in Netpbm 10.50 (March 2010).
182
183
184 .UN copyright
185 .SH COPYRIGHT
186 .PP
187 Copyright\ \(co 2010–2021 Scott Pakin,
188 \fI\[email protected]\fP\fP.
189
190 .UN index
191 .SH Table Of Contents
192
193
194 .IP \(bu
195 .UR #synopsis
196 SYNOPSIS
197 .UE
198 \&
199 .IP \(bu
200 .UR #description
201 DESCRIPTION
202 .UE
203 \&
204 .IP \(bu
205 .UR #options
206 OPTIONS
207 .UE
208 \&
209 .IP \(bu
210 .UR #seealso
211 SEE ALSO
212 .UE
213 \&
214 .IP \(bu
215 .UR #history
216 HISTORY
217 .UE
218 \&
219 .IP \(bu
220 .UR #copyright
221 COPYRIGHT
222 .UE
223 \&
224 .SH DOCUMENT SOURCE
225 This manual page was generated by the Netpbm tool 'makeman' from HTML
226 source. The master documentation is at
227 .IP
228 .B http://netpbm.sourceforge.net/doc/pampaintspill.html
229 .PP