Debian Codegraph @

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