1 | #! perl |
1 | #! perl |
2 | |
2 | |
3 | #:META:X_RESOURCE:%.expr:string:background expression |
3 | #:META:X_RESOURCE:%.expr:string:background expression |
4 | #:META:X_RESOURCE:%.enable:boolean:some boolean |
4 | #:META:X_RESOURCE:%.border.:boolean:respect the terminal border |
5 | #:META:X_RESOURCE:%.extra.:value:extra config |
|
|
6 | |
5 | |
7 | our $EXPR; |
6 | #TODO: once, rootalign |
8 | #$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"'; |
|
|
9 | $EXPR = 'move -TX, -TY, load "argb.png"'; |
|
|
10 | #$EXPR = ' |
|
|
11 | # rotate W, H, 50, 50, counter 1/59.95, repeat_mirror, |
|
|
12 | # clip X, Y, W, H, repeat_mirror, |
|
|
13 | # load "/root/pix/das_fette_schwein.jpg" |
|
|
14 | #'; |
|
|
15 | #$EXPR = 'solid "red"'; |
|
|
16 | #$EXPR = 'blur root, 10, 10' |
|
|
17 | #$EXPR = 'blur move (root, -x, -y), 5, 5' |
|
|
18 | #resize load "/root/pix/das_fette_schwein.jpg", w, h |
|
|
19 | |
7 | |
20 | use Safe; |
8 | =head1 NAME |
21 | |
9 | |
|
|
10 | background - manage terminal background |
|
|
11 | |
|
|
12 | =head1 SYNOPSIS |
|
|
13 | |
|
|
14 | urxvt --background-expr 'background expression' |
|
|
15 | --background-border |
|
|
16 | |
|
|
17 | =head1 DESCRIPTION |
|
|
18 | |
|
|
19 | This extension manages the terminal background by creating a picture that |
|
|
20 | is behind the text, replacing the normal background colour. |
|
|
21 | |
|
|
22 | It does so by evaluating a Perl expression that I<calculates> the image on |
|
|
23 | the fly, for example, by grabbing the root background or loading a file. |
|
|
24 | |
|
|
25 | While the full power of Perl is available, the operators have been design |
|
|
26 | to be as simple as possible. |
|
|
27 | |
|
|
28 | For example, to load an image and scale it to the window size, you would |
|
|
29 | use: |
|
|
30 | |
|
|
31 | urxvt --background-expr 'scale load "/path/to/mybg.png"' |
|
|
32 | |
|
|
33 | Or specified as a X resource: |
|
|
34 | |
|
|
35 | URxvt.background-expr: scale load "/path/to/mybg.png" |
|
|
36 | |
|
|
37 | =head1 THEORY OF OPERATION |
|
|
38 | |
|
|
39 | At startup, just before the window is mapped for the first time, the |
|
|
40 | expression is evaluated and must yield an image. The image is then |
|
|
41 | extended as necessary to cover the whole terminal window, and is set as a |
|
|
42 | background pixmap. |
|
|
43 | |
|
|
44 | If the image contains an alpha channel, then it will be used as-is in |
|
|
45 | visuals that support alpha channels (for example, for a compositing |
|
|
46 | manager). In other visuals, the terminal background colour will be used to |
|
|
47 | replace any transparency. |
|
|
48 | |
|
|
49 | When the expression relies, directly or indirectly, on the window size, |
|
|
50 | position, the root pixmap, or a timer, then it will be remembered. If not, |
|
|
51 | then it will be removed. |
|
|
52 | |
|
|
53 | If any of the parameters that the expression relies on changes (when the |
|
|
54 | window is moved or resized, its position or size changes; when the root |
|
|
55 | pixmap is replaced by another one the root background changes; or when the |
|
|
56 | timer elapses), then the expression will be evaluated again. |
|
|
57 | |
|
|
58 | For example, an expression such as C<scale load "$HOME/mybg.png"> scales the |
|
|
59 | image to the window size, so it relies on the window size and will |
|
|
60 | be reevaluated each time it is changed, but not when it moves for |
|
|
61 | example. That ensures that the picture always fills the terminal, even |
|
|
62 | after it's size changes. |
|
|
63 | |
|
|
64 | =head2 EXPRESSIONS |
|
|
65 | |
|
|
66 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
|
|
67 | which means you could use multiple lines and statements: |
|
|
68 | |
|
|
69 | again 3600; |
|
|
70 | if (localtime now)[6]) { |
|
|
71 | return scale load "$HOME/weekday.png"; |
|
|
72 | } else { |
|
|
73 | return scale load "$HOME/sunday.png"; |
|
|
74 | } |
|
|
75 | |
|
|
76 | This expression gets evaluated once per hour. It will set F<sunday.png> as |
|
|
77 | background on Sundays, and F<weekday.png> on all other days. |
|
|
78 | |
|
|
79 | Fortunately, we expect that most expressions will be much simpler, with |
|
|
80 | little Perl knowledge needed. |
|
|
81 | |
|
|
82 | Basically, you always start with a function that "generates" an image |
|
|
83 | object, such as C<load>, which loads an image from disk, or C<root>, which |
|
|
84 | returns the root window background image: |
|
|
85 | |
|
|
86 | load "$HOME/mypic.png" |
|
|
87 | |
|
|
88 | The path is usually specified as a quoted string (the exact rules can be |
|
|
89 | found in the L<perlop> manpage). The F<$HOME> at the beginning of the |
|
|
90 | string is expanded to the home directory. |
|
|
91 | |
|
|
92 | Then you prepend one or more modifiers or filtering expressions, such as |
|
|
93 | C<scale>: |
|
|
94 | |
|
|
95 | scale load "$HOME/mypic.png" |
|
|
96 | |
|
|
97 | Just like a mathematical expression with functions, you should read these |
|
|
98 | expressions from right to left, as the C<load> is evaluated first, and |
|
|
99 | its result becomes the argument to the C<scale> function. |
|
|
100 | |
|
|
101 | Many operators also allow some parameters preceding the input image |
|
|
102 | that modify its behaviour. For example, C<scale> without any additional |
|
|
103 | arguments scales the image to size of the terminal window. If you specify |
|
|
104 | an additional argument, it uses it as a scale factor (multiply by 100 to |
|
|
105 | get a percentage): |
|
|
106 | |
|
|
107 | scale 2, load "$HOME/mypic.png" |
|
|
108 | |
|
|
109 | This enlarges the image by a factor of 2 (200%). As you can see, C<scale> |
|
|
110 | has now two arguments, the C<200> and the C<load> expression, while |
|
|
111 | C<load> only has one argument. Arguments are separated from each other by |
|
|
112 | commas. |
|
|
113 | |
|
|
114 | Scale also accepts two arguments, which are then separate factors for both |
|
|
115 | horizontal and vertical dimensions. For example, this halves the image |
|
|
116 | width and doubles the image height: |
|
|
117 | |
|
|
118 | scale 0.5, 2, load "$HOME/mypic.png" |
|
|
119 | |
|
|
120 | Other effects than scalign are also readily available, for exmaple, you can |
|
|
121 | tile the image to fill the whole window, instead of resizing it: |
|
|
122 | |
|
|
123 | tile load "$HOME/mypic.png" |
|
|
124 | |
|
|
125 | In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator |
|
|
126 | is kind of superfluous. |
|
|
127 | |
|
|
128 | Another common effect is to mirror the image, so that the same edges touch: |
|
|
129 | |
|
|
130 | mirror load "$HOME/mypic.png" |
|
|
131 | |
|
|
132 | This is also a typical background expression: |
|
|
133 | |
|
|
134 | rootalign root |
|
|
135 | |
|
|
136 | It first takes a snapshot of the screen background image, and then |
|
|
137 | moves it to the upper left corner of the screen - the result is |
|
|
138 | pseudo-transparency, as the image seems to be static while the window is |
|
|
139 | moved around. |
|
|
140 | |
|
|
141 | =head2 CYCLES AND CACHING |
|
|
142 | |
|
|
143 | As has been mentioned before, the expression might be evaluated multiple |
|
|
144 | times. Each time the expression is reevaluated, a new cycle is said to |
|
|
145 | have begun. Many operators cache their results till the next cycle. |
|
|
146 | |
|
|
147 | For example, the C<load> operator keeps a copy of the image. If it is |
|
|
148 | asked to load the same image on the next cycle it will not load it again, |
|
|
149 | but return the cached copy. |
|
|
150 | |
|
|
151 | This only works for one cycle though, so as long as you load the same |
|
|
152 | image every time, it will always be cached, but when you load a different |
|
|
153 | image, it will forget about the first one. |
|
|
154 | |
|
|
155 | This allows you to either speed things up by keeping multiple images in |
|
|
156 | memory, or comserve memory by loading images more often. |
|
|
157 | |
|
|
158 | For example, you can keep two images in memory and use a random one like |
|
|
159 | this: |
|
|
160 | |
|
|
161 | my $img1 = load "img1.png"; |
|
|
162 | my $img2 = load "img2.png"; |
|
|
163 | (0.5 > rand) ? $img1 : $img2 |
|
|
164 | |
|
|
165 | Since both images are "loaded" every time the expression is evaluated, |
|
|
166 | they are always kept in memory. Contrast this version: |
|
|
167 | |
|
|
168 | my $path1 = "img1.png"; |
|
|
169 | my $path2 = "img2.png"; |
|
|
170 | load ((0.5 > rand) ? $path1 : $path2) |
|
|
171 | |
|
|
172 | Here, a path is selected randomly, and load is only called for one image, |
|
|
173 | so keeps only one image in memory. If, on the next evaluation, luck |
|
|
174 | decides to use the other path, then it will have to load that image again. |
|
|
175 | |
|
|
176 | =head1 REFERENCE |
|
|
177 | |
|
|
178 | =head2 COMMAND LINE SWITCHES |
|
|
179 | |
|
|
180 | =over 4 |
|
|
181 | |
|
|
182 | =item --background-expr perl-expression |
|
|
183 | |
|
|
184 | Specifies the Perl expression to evaluate. |
|
|
185 | |
|
|
186 | =item --background-border |
|
|
187 | |
|
|
188 | By default, the expression creates an image that fills the full window, |
|
|
189 | overwriting borders and any other areas, such as the scrollbar. |
|
|
190 | |
|
|
191 | Specifying this flag changes the behaviour, so that the image only |
|
|
192 | replaces the background of the character area. |
|
|
193 | |
|
|
194 | =back |
|
|
195 | |
|
|
196 | =cut |
|
|
197 | |
|
|
198 | our $HOME; |
22 | our ($bgdsl_self, $old, $new); |
199 | our ($self, $old, $new); |
23 | our ($x, $y, $w, $h); |
200 | our ($x, $y, $w, $h); |
24 | |
201 | |
25 | # enforce at least this interval between updates |
202 | # enforce at least this interval between updates |
26 | our $MIN_INTERVAL = 1/100; |
203 | our $MIN_INTERVAL = 1/100; |
27 | |
204 | |
28 | { |
205 | { |
29 | package urxvt::bgdsl; # background language |
206 | package urxvt::bgdsl; # background language |
|
|
207 | |
|
|
208 | use List::Util qw(min max sum shuffle); |
30 | |
209 | |
31 | =head2 PROVIDERS/GENERATORS |
210 | =head2 PROVIDERS/GENERATORS |
32 | |
211 | |
33 | These functions provide an image, by loading it from disk, grabbing it |
212 | These functions provide an image, by loading it from disk, grabbing it |
34 | from the root screen or by simply generating it. They are used as starting |
213 | from the root screen or by simply generating it. They are used as starting |
… | |
… | |
46 | =cut |
225 | =cut |
47 | |
226 | |
48 | sub load($) { |
227 | sub load($) { |
49 | my ($path) = @_; |
228 | my ($path) = @_; |
50 | |
229 | |
51 | $new->{load}{$path} = $old->{load}{$path} || $bgdsl_self->new_img_from_file ($path); |
230 | $new->{load}{$path} = $old->{load}{$path} || $self->new_img_from_file ($path); |
52 | } |
231 | } |
53 | |
232 | |
54 | =item root |
233 | =item root |
55 | |
234 | |
56 | Returns the root window pixmap, that is, hopefully, the background image |
235 | Returns the root window pixmap, that is, hopefully, the background image |
… | |
… | |
71 | =item solid $width, $height, $colour |
250 | =item solid $width, $height, $colour |
72 | |
251 | |
73 | Creates a new image and completely fills it with the given colour. The |
252 | Creates a new image and completely fills it with the given colour. The |
74 | image is set to tiling mode. |
253 | image is set to tiling mode. |
75 | |
254 | |
76 | If <$width> and C<$height> are omitted, it creates a 1x1 image, which is |
255 | If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is |
77 | useful for solid backgrounds or for use in filtering effects. |
256 | useful for solid backgrounds or for use in filtering effects. |
78 | |
257 | |
79 | =cut |
258 | =cut |
80 | |
259 | |
81 | sub solid($$;$) { |
260 | sub solid($;$$) { |
82 | my $colour = pop; |
261 | my $colour = pop; |
83 | |
262 | |
84 | my $img = $bgdsl_self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); |
263 | my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); |
85 | $img->fill ($colour); |
264 | $img->fill ($colour); |
86 | $img |
265 | $img |
87 | } |
266 | } |
88 | |
267 | |
89 | =back |
268 | =back |
90 | |
269 | |
91 | =head2 VARIABLES |
270 | =head2 VARIABLES |
92 | |
271 | |
93 | The following functions provide variable data such as the terminal |
272 | The following functions provide variable data such as the terminal window |
|
|
273 | dimensions. They are not (Perl-) variables, they jsut return stuff that |
94 | window dimensions. Most of them make your expression sensitive to some |
274 | varies. Most of them make your expression sensitive to some events, for |
95 | events, for example using C<TW> (terminal width) means your expression is |
275 | example using C<TW> (terminal width) means your expression is evaluated |
96 | evaluated again when the terminal is resized. |
276 | again when the terminal is resized. |
97 | |
277 | |
98 | =over 4 |
278 | =over 4 |
99 | |
279 | |
100 | =item TX |
280 | =item TX |
101 | |
281 | |
… | |
… | |
135 | sub TX() { $new->{position_sensitive} = 1; $x } |
315 | sub TX() { $new->{position_sensitive} = 1; $x } |
136 | sub TY() { $new->{position_sensitive} = 1; $y } |
316 | sub TY() { $new->{position_sensitive} = 1; $y } |
137 | sub TW() { $new->{size_sensitive} = 1; $w } |
317 | sub TW() { $new->{size_sensitive} = 1; $w } |
138 | sub TH() { $new->{size_sensitive} = 1; $h } |
318 | sub TH() { $new->{size_sensitive} = 1; $h } |
139 | |
319 | |
|
|
320 | =item now |
|
|
321 | |
|
|
322 | Returns the current time as (fractional) seconds since the epoch. |
|
|
323 | |
|
|
324 | Using this expression does I<not> make your expression sensitive to time, |
|
|
325 | but the next two functions do. |
|
|
326 | |
|
|
327 | =item again $seconds |
|
|
328 | |
|
|
329 | When this function is used the expression will be reevaluated again in |
|
|
330 | C<$seconds> seconds. |
|
|
331 | |
|
|
332 | Example: load some image and rotate it according to the time of day (as if it were |
|
|
333 | the hour pointer of a clock). Update this image every minute. |
|
|
334 | |
|
|
335 | again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" |
|
|
336 | |
|
|
337 | =item counter $seconds |
|
|
338 | |
|
|
339 | Like C<again>, but also returns an increasing counter value, starting at |
|
|
340 | 0, which might be useful for some simple animation effects. |
|
|
341 | |
|
|
342 | =cut |
|
|
343 | |
140 | sub now() { urxvt::NOW } |
344 | sub now() { urxvt::NOW } |
141 | |
345 | |
142 | sub again($) { |
346 | sub again($) { |
143 | $new->{again} = $_[0]; |
347 | $new->{again} = $_[0]; |
144 | } |
348 | } |
145 | |
349 | |
146 | sub counter($) { |
350 | sub counter($) { |
147 | $new->{again} = $_[0]; |
351 | $new->{again} = $_[0]; |
148 | $bgdsl_self->{counter} + 0 |
352 | $self->{counter} + 0 |
149 | } |
353 | } |
150 | |
354 | |
151 | =back |
355 | =back |
152 | |
356 | |
153 | =head2 TILING MODES |
357 | =head2 TILING MODES |
… | |
… | |
159 | |
363 | |
160 | =item tile $img |
364 | =item tile $img |
161 | |
365 | |
162 | Tiles the whole plane with the image and returns this new image - or in |
366 | Tiles the whole plane with the image and returns this new image - or in |
163 | other words, it returns a copy of the image in plane tiling mode. |
367 | other words, it returns a copy of the image in plane tiling mode. |
|
|
368 | |
|
|
369 | Example: load an image and tile it over the background, without |
|
|
370 | resizing. The C<tile> call is superfluous because C<load> already defaults |
|
|
371 | to tiling mode. |
|
|
372 | |
|
|
373 | tile load "mybg.png" |
164 | |
374 | |
165 | =item mirror $img |
375 | =item mirror $img |
166 | |
376 | |
167 | Similar to tile, but reflects the image each time it uses a new copy, so |
377 | Similar to tile, but reflects the image each time it uses a new copy, so |
168 | that top edges always touch top edges, right edges always touch right |
378 | that top edges always touch top edges, right edges always touch right |
169 | edges and so on (with normal tiling, left edges always touch right edges |
379 | edges and so on (with normal tiling, left edges always touch right edges |
170 | and top always touch bottom edges). |
380 | and top always touch bottom edges). |
171 | |
381 | |
|
|
382 | Example: load an image and mirror it over the background, avoiding sharp |
|
|
383 | edges at the image borders at the expense of mirroring the image itself |
|
|
384 | |
|
|
385 | mirror load "mybg.png" |
|
|
386 | |
172 | =item pad $img |
387 | =item pad $img |
173 | |
388 | |
174 | Takes an image and modifies it so that all pixels outside the image area |
389 | Takes an image and modifies it so that all pixels outside the image area |
175 | become transparent. This mode is most useful when you want to place an |
390 | become transparent. This mode is most useful when you want to place an |
176 | image over another image or the background colour while leaving all |
391 | image over another image or the background colour while leaving all |
177 | background pixels outside the image unchanged. |
392 | background pixels outside the image unchanged. |
178 | |
393 | |
|
|
394 | Example: load an image and display it in the upper left corner. The rest |
|
|
395 | of the space is left "empty" (transparent or wahtever your compisotr does |
|
|
396 | in alpha mode, else background colour). |
|
|
397 | |
|
|
398 | pad load "mybg.png" |
|
|
399 | |
179 | =item extend $img |
400 | =item extend $img |
180 | |
401 | |
181 | Extends the image over the whole plane, using the closest pixel in the |
402 | Extends the image over the whole plane, using the closest pixel in the |
182 | area outside the image. This mode is mostly useful when you more complex |
403 | area outside the image. This mode is mostly useful when you more complex |
183 | filtering operations and want the pixels outside the image to have the |
404 | filtering operations and want the pixels outside the image to have the |
184 | same values as the pixels near the edge. |
405 | same values as the pixels near the edge. |
185 | |
406 | |
|
|
407 | Example: just for curiosity, how does this pixel extension stuff work? |
|
|
408 | |
|
|
409 | extend move 50, 50, load "mybg.png" |
|
|
410 | |
186 | =cut |
411 | =cut |
187 | |
412 | |
188 | sub pad($) { |
413 | sub pad($) { |
189 | my $img = $_[0]->clone; |
414 | my $img = $_[0]->clone; |
190 | $img->repeat_mode (urxvt::RepeatNone); |
415 | $img->repeat_mode (urxvt::RepeatNone); |
… | |
… | |
257 | $img->sub_rect ($_[0], $_[1], $w, $h) |
482 | $img->sub_rect ($_[0], $_[1], $w, $h) |
258 | } |
483 | } |
259 | |
484 | |
260 | =item scale $img |
485 | =item scale $img |
261 | |
486 | |
262 | =item scale $size_percent, $img |
487 | =item scale $size_factor, $img |
263 | |
488 | |
264 | =item scale $width_percent, $height_percent, $img |
489 | =item scale $width_factor, $height_factor, $img |
265 | |
490 | |
266 | Scales the image by the given percentages in horizontal |
491 | Scales the image by the given factors in horizontal |
267 | (C<$width_percent>) and vertical (C<$height_percent>) direction. |
492 | (C<$width>) and vertical (C<$height>) direction. |
268 | |
493 | |
269 | If only one percentage is give, it is used for both directions. |
494 | If only one factor is give, it is used for both directions. |
270 | |
495 | |
271 | If no percentages are given, scales the image to the window size without |
496 | If no factors are given, scales the image to the window size without |
272 | keeping aspect. |
497 | keeping aspect. |
273 | |
498 | |
274 | =item resize $width, $height, $img |
499 | =item resize $width, $height, $img |
275 | |
500 | |
276 | Resizes the image to exactly C<$width> times C<$height> pixels. |
501 | Resizes the image to exactly C<$width> times C<$height> pixels. |
277 | |
502 | |
278 | =cut |
503 | =item fit $img |
279 | |
504 | |
280 | #TODO: maximise, maximise_fill? |
505 | =item fit $width, $height, $img |
281 | |
506 | |
|
|
507 | Fits the image into the given C<$width> and C<$height> without changing |
|
|
508 | aspect, or the terminal size. That means it will be shrunk or grown until |
|
|
509 | the whole image fits into the given area, possibly leaving borders. |
|
|
510 | |
|
|
511 | =item cover $img |
|
|
512 | |
|
|
513 | =item cover $width, $height, $img |
|
|
514 | |
|
|
515 | Similar to C<fit>, but shrinks or grows until all of the area is covered |
|
|
516 | by the image, so instead of potentially leaving borders, it will cut off |
|
|
517 | image data that doesn't fit. |
|
|
518 | |
|
|
519 | =cut |
|
|
520 | |
282 | sub scale($$$) { |
521 | sub scale($;$;$) { |
283 | my $img = pop; |
522 | my $img = pop; |
284 | |
523 | |
285 | @_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01) |
524 | @_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h) |
286 | : @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01) |
525 | : @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h) |
287 | : $img->scale (TW, TH) |
526 | : $img->scale (TW, TH) |
288 | } |
527 | } |
289 | |
528 | |
290 | sub resize($$$) { |
529 | sub resize($$$) { |
291 | my $img = pop; |
530 | my $img = pop; |
292 | $img->scale ($_[0], $_[1]) |
531 | $img->scale ($_[0], $_[1]) |
293 | } |
532 | } |
|
|
533 | |
|
|
534 | sub fit($;$$) { |
|
|
535 | my $img = pop; |
|
|
536 | my $w = ($_[0] || TW) / $img->w; |
|
|
537 | my $h = ($_[1] || TH) / $img->h; |
|
|
538 | scale +(min $w, $h), $img |
|
|
539 | } |
|
|
540 | |
|
|
541 | sub cover($;$$) { |
|
|
542 | my $img = pop; |
|
|
543 | my $w = ($_[0] || TW) / $img->w; |
|
|
544 | my $h = ($_[1] || TH) / $img->h; |
|
|
545 | scale +(max $w, $h), $img |
|
|
546 | } |
|
|
547 | |
|
|
548 | =item move $dx, $dy, $img |
|
|
549 | |
|
|
550 | Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in |
|
|
551 | the vertical. |
|
|
552 | |
|
|
553 | Example: move the image right by 20 pixels and down by 30. |
|
|
554 | |
|
|
555 | move 20, 30, ... |
|
|
556 | |
|
|
557 | =item rootalign $img |
|
|
558 | |
|
|
559 | Moves the image so that it appears glued to the screen as opposed to the |
|
|
560 | window. This gives the illusion of a larger area behind the window. It is |
|
|
561 | exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
|
|
562 | top left of the screen. |
|
|
563 | |
|
|
564 | Example: load a background image, put it in mirror mode and root align it. |
|
|
565 | |
|
|
566 | rootalign mirror load "mybg.png" |
|
|
567 | |
|
|
568 | Example: take the screen background and align it, giving the illusion of |
|
|
569 | transparency as long as the window isn't in front of other windows. |
|
|
570 | |
|
|
571 | rootalign root |
|
|
572 | |
|
|
573 | =cut |
294 | |
574 | |
295 | sub move($$;$) { |
575 | sub move($$;$) { |
296 | my $img = pop->clone; |
576 | my $img = pop->clone; |
297 | $img->move ($_[0], $_[1]); |
577 | $img->move ($_[0], $_[1]); |
298 | $img |
578 | $img |
299 | } |
579 | } |
300 | |
580 | |
|
|
581 | sub rootalign($) { |
|
|
582 | move -TX, -TY, $_[0] |
|
|
583 | } |
|
|
584 | |
|
|
585 | =item contrast $factor, $img |
|
|
586 | |
|
|
587 | =item contrast $r, $g, $b, $img |
|
|
588 | |
|
|
589 | =item contrast $r, $g, $b, $a, $img |
|
|
590 | |
|
|
591 | Adjusts the I<contrast> of an image. |
|
|
592 | |
|
|
593 | #TODO# |
|
|
594 | |
|
|
595 | =item brightness $factor, $img |
|
|
596 | |
|
|
597 | =item brightness $r, $g, $b, $img |
|
|
598 | |
|
|
599 | =item brightness $r, $g, $b, $a, $img |
|
|
600 | |
|
|
601 | Adjusts the brightness of an image. |
|
|
602 | |
|
|
603 | =cut |
|
|
604 | |
|
|
605 | sub contrast($$;$$;$) { |
|
|
606 | my $img = pop; |
|
|
607 | my ($r, $g, $b, $a) = @_; |
|
|
608 | |
|
|
609 | ($g, $b) = ($r, $r) if @_ < 4; |
|
|
610 | $a = 1 if @_ < 5; |
|
|
611 | |
|
|
612 | $img = $img->clone; |
|
|
613 | $img->contrast ($r, $g, $b, $a); |
|
|
614 | $img |
|
|
615 | } |
|
|
616 | |
|
|
617 | sub brightness($$;$$;$) { |
|
|
618 | my $img = pop; |
|
|
619 | my ($r, $g, $b, $a) = @_; |
|
|
620 | |
|
|
621 | ($g, $b) = ($r, $r) if @_ < 4; |
|
|
622 | $a = 1 if @_ < 5; |
|
|
623 | |
|
|
624 | $img = $img->clone; |
|
|
625 | $img->brightness ($r, $g, $b, $a); |
|
|
626 | $img |
|
|
627 | } |
|
|
628 | |
|
|
629 | =item blur $radius, $img |
|
|
630 | |
|
|
631 | =item blur $radius_horz, $radius_vert, $img |
|
|
632 | |
|
|
633 | Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii |
|
|
634 | can also be specified separately. |
|
|
635 | |
|
|
636 | Blurring is often I<very> slow, at least compared or other |
|
|
637 | operators. Larger blur radii are slower than smaller ones, too, so if you |
|
|
638 | don't want to freeze your screen for long times, start experimenting with |
|
|
639 | low values for radius (<5). |
|
|
640 | |
|
|
641 | =cut |
|
|
642 | |
|
|
643 | sub blur($$;$) { |
|
|
644 | my $img = pop; |
|
|
645 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
|
|
646 | } |
|
|
647 | |
|
|
648 | =item rotate $new_width, $new_height, $center_x, $center_y, $degrees |
|
|
649 | |
|
|
650 | Rotates the image by C<$degrees> degrees, counter-clockwise, around the |
|
|
651 | pointer at C<$center_x> and C<$center_y> (specified as factor of image |
|
|
652 | width/height), generating a new image with width C<$new_width> and height |
|
|
653 | C<$new_height>. |
|
|
654 | |
|
|
655 | #TODO# new width, height, maybe more operators? |
|
|
656 | |
|
|
657 | Example: rotate the image by 90 degrees |
|
|
658 | |
|
|
659 | =cut |
|
|
660 | |
301 | sub rotate($$$$$$) { |
661 | sub rotate($$$$$$) { |
302 | my $img = pop; |
662 | my $img = pop; |
303 | $img->rotate ( |
663 | $img->rotate ( |
304 | $_[0], |
664 | $_[0], |
305 | $_[1], |
665 | $_[1], |
306 | $_[2] * $img->w * .01, |
666 | $_[2] * $img->w, |
307 | $_[3] * $img->h * .01, |
667 | $_[3] * $img->h, |
308 | $_[4] * (3.14159265 / 180), |
668 | $_[4] * (3.14159265 / 180), |
309 | ) |
669 | ) |
310 | } |
|
|
311 | |
|
|
312 | sub blur($$;$) { |
|
|
313 | my $img = pop; |
|
|
314 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
|
|
315 | } |
|
|
316 | |
|
|
317 | sub contrast($$;$$;$) { |
|
|
318 | my $img = pop; |
|
|
319 | my ($r, $g, $b, $a) = @_; |
|
|
320 | |
|
|
321 | ($g, $b) = ($r, $r) if @_ < 4; |
|
|
322 | $a = 1 if @_ < 5; |
|
|
323 | |
|
|
324 | $img = $img->clone; |
|
|
325 | $img->contrast ($r, $g, $b, $a); |
|
|
326 | $img |
|
|
327 | } |
|
|
328 | |
|
|
329 | sub brightness($$;$$;$) { |
|
|
330 | my $img = pop; |
|
|
331 | my ($r, $g, $b, $a) = @_; |
|
|
332 | |
|
|
333 | ($g, $b) = ($r, $r) if @_ < 4; |
|
|
334 | $a = 1 if @_ < 5; |
|
|
335 | |
|
|
336 | $img = $img->clone; |
|
|
337 | $img->brightness ($r, $g, $b, $a); |
|
|
338 | $img |
|
|
339 | } |
670 | } |
340 | |
671 | |
341 | =back |
672 | =back |
342 | |
673 | |
343 | =cut |
674 | =cut |
… | |
… | |
358 | $self->recalculate; |
689 | $self->recalculate; |
359 | } |
690 | } |
360 | |
691 | |
361 | # evaluate the current bg expression |
692 | # evaluate the current bg expression |
362 | sub recalculate { |
693 | sub recalculate { |
363 | my ($self) = @_; |
694 | my ($arg_self) = @_; |
364 | |
695 | |
365 | # rate limit evaluation |
696 | # rate limit evaluation |
366 | |
697 | |
367 | if ($self->{next_refresh} > urxvt::NOW) { |
698 | if ($arg_self->{next_refresh} > urxvt::NOW) { |
368 | $self->{next_refresh_timer} = urxvt::timer->new->after ($self->{next_refresh} - urxvt::NOW)->cb (sub { |
699 | $arg_self->{next_refresh_timer} = urxvt::timer->new->after ($arg_self->{next_refresh} - urxvt::NOW)->cb (sub { |
369 | $self->recalculate; |
700 | $arg_self->recalculate; |
370 | }); |
701 | }); |
371 | return; |
702 | return; |
372 | } |
703 | } |
373 | |
704 | |
374 | $self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
705 | $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
375 | |
706 | |
376 | # set environment to evaluate user expression |
707 | # set environment to evaluate user expression |
377 | |
708 | |
378 | local $bgdsl_self = $self; |
709 | local $self = $arg_self; |
379 | |
710 | |
|
|
711 | local $HOME = $ENV{HOME}; |
380 | local $old = $self->{state}; |
712 | local $old = $self->{state}; |
381 | local $new = my $state = $self->{state} = {}; |
713 | local $new = my $state = $self->{state} = {}; |
382 | |
714 | |
383 | my $border = 0; #d# |
|
|
384 | |
|
|
385 | ($x, $y, $w, $h) = |
715 | ($x, $y, $w, $h) = |
386 | $self->background_geometry ($border); |
716 | $self->background_geometry ($self->{border}); |
387 | |
717 | |
388 | # evaluate user expression |
718 | # evaluate user expression |
389 | |
719 | |
390 | my $img = eval { $self->{expr}->() }; |
720 | my $img = eval { $self->{expr}->() }; |
391 | warn $@ if $@;#d# |
721 | warn $@ if $@;#d# |
392 | die if !UNIVERSAL::isa $img, "urxvt::img"; |
722 | die if !UNIVERSAL::isa $img, "urxvt::img"; |
393 | |
723 | |
|
|
724 | $state->{size_sensitive} = 1 |
|
|
725 | if $img->repeat_mode != urxvt::RepeatNormal; |
|
|
726 | |
394 | # if the expression is sensitive to external events, prepare reevaluation then |
727 | # if the expression is sensitive to external events, prepare reevaluation then |
395 | |
728 | |
396 | my $repeat; |
729 | my $repeat; |
397 | |
730 | |
398 | if (my $again = $state->{again}) { |
731 | if (my $again = $state->{again}) { |
399 | $repeat = 1; |
732 | $repeat = 1; |
|
|
733 | my $self = $self; |
400 | $state->{timer} = $again == $old->{again} |
734 | $state->{timer} = $again == $old->{again} |
401 | ? $old->{timer} |
735 | ? $old->{timer} |
402 | : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { |
736 | : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { |
403 | ++$self->{counter}; |
737 | ++$self->{counter}; |
404 | $self->recalculate |
738 | $self->recalculate |
… | |
… | |
433 | unless ($repeat) { |
767 | unless ($repeat) { |
434 | delete $self->{state}; |
768 | delete $self->{state}; |
435 | delete $self->{expr}; |
769 | delete $self->{expr}; |
436 | } |
770 | } |
437 | |
771 | |
438 | # prepare and set background pixmap |
772 | # set background pixmap |
439 | |
773 | |
440 | $img = $img->sub_rect (0, 0, $w, $h) |
|
|
441 | if $img->w != $w || $img->h != $h; |
|
|
442 | |
|
|
443 | $self->set_background ($img, $border); |
774 | $self->set_background ($img, $self->{border}); |
444 | $self->scr_recolour (0); |
775 | $self->scr_recolour (0); |
445 | $self->want_refresh; |
776 | $self->want_refresh; |
446 | } |
777 | } |
447 | |
778 | |
448 | sub on_start { |
779 | sub on_start { |
449 | my ($self) = @_; |
780 | my ($self) = @_; |
450 | |
781 | |
|
|
782 | my $expr = $self->x_resource ("background.expr") |
|
|
783 | or return; |
|
|
784 | |
451 | $self->set_expr (parse_expr $EXPR); |
785 | $self->set_expr (parse_expr $expr); |
|
|
786 | $self->{border} = $self->x_resource_boolean ("background.border"); |
452 | |
787 | |
453 | () |
788 | () |
454 | } |
789 | } |
455 | |
790 | |