1 |
#! perl |
2 |
|
3 |
#:META:X_RESOURCE:%.expr:string:background expression |
4 |
#:META:X_RESOURCE:%.border:boolean:respect the terminal border |
5 |
#:META:X_RESOURCE:%.interval:seconds:minimum time between updates |
6 |
|
7 |
=head1 NAME |
8 |
|
9 |
background - manage terminal background |
10 |
|
11 |
=head1 SYNOPSIS |
12 |
|
13 |
urxvt --background-expr 'background expression' |
14 |
--background-border |
15 |
--background-interval seconds |
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 |
=item --background-interval seconds |
195 |
|
196 |
Since some operations in the underlying XRender extension can effetively |
197 |
freeze your X-server for prolonged time, this extension enforces a minimum |
198 |
time between updates, which is normally about 0.1 seconds. |
199 |
|
200 |
If you want to do updates more often, you can decrease this safety |
201 |
interval with this switch. |
202 |
|
203 |
=back |
204 |
|
205 |
=cut |
206 |
|
207 |
our %_IMGCACHE; |
208 |
our $HOME; |
209 |
our ($self, $old, $new); |
210 |
our ($x, $y, $w, $h); |
211 |
|
212 |
# enforce at least this interval between updates |
213 |
our $MIN_INTERVAL = 6/59.951; |
214 |
|
215 |
{ |
216 |
package urxvt::bgdsl; # background language |
217 |
|
218 |
use List::Util qw(min max sum shuffle); |
219 |
|
220 |
=head2 PROVIDERS/GENERATORS |
221 |
|
222 |
These functions provide an image, by loading it from disk, grabbing it |
223 |
from the root screen or by simply generating it. They are used as starting |
224 |
points to get an image you can play with. |
225 |
|
226 |
=over 4 |
227 |
|
228 |
=item load $path |
229 |
|
230 |
Loads the image at the given C<$path>. The image is set to plane tiling |
231 |
mode. |
232 |
|
233 |
Loaded images will be cached for one cycle. |
234 |
|
235 |
=cut |
236 |
|
237 |
sub load($) { |
238 |
my ($path) = @_; |
239 |
|
240 |
$new->{load}{$path} = $old->{load}{$path} || $self->new_img_from_file ($path); |
241 |
} |
242 |
|
243 |
=item root |
244 |
|
245 |
Returns the root window pixmap, that is, hopefully, the background image |
246 |
of your screen. The image is set to extend mode. |
247 |
|
248 |
This function makes your expression root sensitive, that means it will be |
249 |
reevaluated when the bg image changes. |
250 |
|
251 |
=cut |
252 |
|
253 |
sub root() { |
254 |
$new->{rootpmap_sensitive} = 1; |
255 |
die "root op not supported, exg, we need you"; |
256 |
} |
257 |
|
258 |
=item solid $colour |
259 |
|
260 |
=item solid $width, $height, $colour |
261 |
|
262 |
Creates a new image and completely fills it with the given colour. The |
263 |
image is set to tiling mode. |
264 |
|
265 |
If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is |
266 |
useful for solid backgrounds or for use in filtering effects. |
267 |
|
268 |
=cut |
269 |
|
270 |
sub solid($;$$) { |
271 |
my $colour = pop; |
272 |
|
273 |
my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); |
274 |
$img->fill ($colour); |
275 |
$img |
276 |
} |
277 |
|
278 |
=item clone $img |
279 |
|
280 |
Returns an exact copy of the image. This is useful if you want to have |
281 |
multiple copies of the same image to apply different effects to. |
282 |
|
283 |
=cut |
284 |
|
285 |
sub clone($) { |
286 |
$_[0]->clone |
287 |
} |
288 |
|
289 |
=back |
290 |
|
291 |
=head2 TILING MODES |
292 |
|
293 |
The following operators modify the tiling mode of an image, that is, the |
294 |
way that pixels outside the image area are painted when the image is used. |
295 |
|
296 |
=over 4 |
297 |
|
298 |
=item tile $img |
299 |
|
300 |
Tiles the whole plane with the image and returns this new image - or in |
301 |
other words, it returns a copy of the image in plane tiling mode. |
302 |
|
303 |
Example: load an image and tile it over the background, without |
304 |
resizing. The C<tile> call is superfluous because C<load> already defaults |
305 |
to tiling mode. |
306 |
|
307 |
tile load "mybg.png" |
308 |
|
309 |
=item mirror $img |
310 |
|
311 |
Similar to tile, but reflects the image each time it uses a new copy, so |
312 |
that top edges always touch top edges, right edges always touch right |
313 |
edges and so on (with normal tiling, left edges always touch right edges |
314 |
and top always touch bottom edges). |
315 |
|
316 |
Example: load an image and mirror it over the background, avoiding sharp |
317 |
edges at the image borders at the expense of mirroring the image itself |
318 |
|
319 |
mirror load "mybg.png" |
320 |
|
321 |
=item pad $img |
322 |
|
323 |
Takes an image and modifies it so that all pixels outside the image area |
324 |
become transparent. This mode is most useful when you want to place an |
325 |
image over another image or the background colour while leaving all |
326 |
background pixels outside the image unchanged. |
327 |
|
328 |
Example: load an image and display it in the upper left corner. The rest |
329 |
of the space is left "empty" (transparent or wahtever your compisotr does |
330 |
in alpha mode, else background colour). |
331 |
|
332 |
pad load "mybg.png" |
333 |
|
334 |
=item extend $img |
335 |
|
336 |
Extends the image over the whole plane, using the closest pixel in the |
337 |
area outside the image. This mode is mostly useful when you more complex |
338 |
filtering operations and want the pixels outside the image to have the |
339 |
same values as the pixels near the edge. |
340 |
|
341 |
Example: just for curiosity, how does this pixel extension stuff work? |
342 |
|
343 |
extend move 50, 50, load "mybg.png" |
344 |
|
345 |
=cut |
346 |
|
347 |
sub pad($) { |
348 |
my $img = $_[0]->clone; |
349 |
$img->repeat_mode (urxvt::RepeatNone); |
350 |
$img |
351 |
} |
352 |
|
353 |
sub tile($) { |
354 |
my $img = $_[0]->clone; |
355 |
$img->repeat_mode (urxvt::RepeatNormal); |
356 |
$img |
357 |
} |
358 |
|
359 |
sub mirror($) { |
360 |
my $img = $_[0]->clone; |
361 |
$img->repeat_mode (urxvt::RepeatReflect); |
362 |
$img |
363 |
} |
364 |
|
365 |
sub extend($) { |
366 |
my $img = $_[0]->clone; |
367 |
$img->repeat_mode (urxvt::RepeatPad); |
368 |
$img |
369 |
} |
370 |
|
371 |
=back |
372 |
|
373 |
=head2 VARIABLE VALUES |
374 |
|
375 |
The following functions provide variable data such as the terminal window |
376 |
dimensions. They are not (Perl-) variables, they just return stuff that |
377 |
varies. Most of them make your expression sensitive to some events, for |
378 |
example using C<TW> (terminal width) means your expression is evaluated |
379 |
again when the terminal is resized. |
380 |
|
381 |
=over 4 |
382 |
|
383 |
=item TX |
384 |
|
385 |
=item TY |
386 |
|
387 |
Return the X and Y coordinates of the terminal window (the terminal |
388 |
window is the full window by default, and the character area only when in |
389 |
border-respect mode). |
390 |
|
391 |
Using these functions make your expression sensitive to window moves. |
392 |
|
393 |
These functions are mainly useful to align images to the root window. |
394 |
|
395 |
Example: load an image and align it so it looks as if anchored to the |
396 |
background. |
397 |
|
398 |
move -TX, -TY, load "mybg.png" |
399 |
|
400 |
=item TW |
401 |
|
402 |
Return the width (C<TW>) and height (C<TH>) of the terminal window (the |
403 |
terminal window is the full window by default, and the character area only |
404 |
when in border-respect mode). |
405 |
|
406 |
Using these functions make your expression sensitive to window resizes. |
407 |
|
408 |
These functions are mainly useful to scale images, or to clip images to |
409 |
the window size to conserve memory. |
410 |
|
411 |
Example: take the screen background, clip it to the window size, blur it a |
412 |
bit, align it to the window position and use it as background. |
413 |
|
414 |
clip move -TX, -TY, blur 5, root |
415 |
|
416 |
=cut |
417 |
|
418 |
sub TX() { $new->{position_sensitive} = 1; $x } |
419 |
sub TY() { $new->{position_sensitive} = 1; $y } |
420 |
sub TW() { $new->{size_sensitive} = 1; $w } |
421 |
sub TH() { $new->{size_sensitive} = 1; $h } |
422 |
|
423 |
=item now |
424 |
|
425 |
Returns the current time as (fractional) seconds since the epoch. |
426 |
|
427 |
Using this expression does I<not> make your expression sensitive to time, |
428 |
but the next two functions do. |
429 |
|
430 |
=item again $seconds |
431 |
|
432 |
When this function is used the expression will be reevaluated again in |
433 |
C<$seconds> seconds. |
434 |
|
435 |
Example: load some image and rotate it according to the time of day (as if it were |
436 |
the hour pointer of a clock). Update this image every minute. |
437 |
|
438 |
again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" |
439 |
|
440 |
=item counter $seconds |
441 |
|
442 |
Like C<again>, but also returns an increasing counter value, starting at |
443 |
0, which might be useful for some simple animation effects. |
444 |
|
445 |
=cut |
446 |
|
447 |
sub now() { urxvt::NOW } |
448 |
|
449 |
sub again($) { |
450 |
$new->{again} = $_[0]; |
451 |
} |
452 |
|
453 |
sub counter($) { |
454 |
$new->{again} = $_[0]; |
455 |
$self->{counter} + 0 |
456 |
} |
457 |
|
458 |
=back |
459 |
|
460 |
=head2 SHAPE CHANGING OPERATORS |
461 |
|
462 |
The following operators modify the shape, size or position of the image. |
463 |
|
464 |
=over 4 |
465 |
|
466 |
=item clip $img |
467 |
|
468 |
=item clip $width, $height, $img |
469 |
|
470 |
=item clip $x, $y, $width, $height, $img |
471 |
|
472 |
Clips an image to the given rectangle. If the rectangle is outside the |
473 |
image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is |
474 |
larger than the image, then the tiling mode defines how the extra pixels |
475 |
will be filled. |
476 |
|
477 |
If C<$x> an C<$y> are missing, then C<0> is assumed for both. |
478 |
|
479 |
If C<$width> and C<$height> are missing, then the window size will be |
480 |
assumed. |
481 |
|
482 |
Example: load an image, blur it, and clip it to the window size to save |
483 |
memory. |
484 |
|
485 |
clip blur 10, load "mybg.png" |
486 |
|
487 |
=cut |
488 |
|
489 |
sub clip($;$$;$$) { |
490 |
my $img = pop; |
491 |
my $h = pop || TH; |
492 |
my $w = pop || TW; |
493 |
$img->sub_rect ($_[0], $_[1], $w, $h) |
494 |
} |
495 |
|
496 |
=item scale $img |
497 |
|
498 |
=item scale $size_factor, $img |
499 |
|
500 |
=item scale $width_factor, $height_factor, $img |
501 |
|
502 |
Scales the image by the given factors in horizontal |
503 |
(C<$width>) and vertical (C<$height>) direction. |
504 |
|
505 |
If only one factor is give, it is used for both directions. |
506 |
|
507 |
If no factors are given, scales the image to the window size without |
508 |
keeping aspect. |
509 |
|
510 |
=item resize $width, $height, $img |
511 |
|
512 |
Resizes the image to exactly C<$width> times C<$height> pixels. |
513 |
|
514 |
=item fit $img |
515 |
|
516 |
=item fit $width, $height, $img |
517 |
|
518 |
Fits the image into the given C<$width> and C<$height> without changing |
519 |
aspect, or the terminal size. That means it will be shrunk or grown until |
520 |
the whole image fits into the given area, possibly leaving borders. |
521 |
|
522 |
=item cover $img |
523 |
|
524 |
=item cover $width, $height, $img |
525 |
|
526 |
Similar to C<fit>, but shrinks or grows until all of the area is covered |
527 |
by the image, so instead of potentially leaving borders, it will cut off |
528 |
image data that doesn't fit. |
529 |
|
530 |
=cut |
531 |
|
532 |
sub scale($;$;$) { |
533 |
my $img = pop; |
534 |
|
535 |
@_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h) |
536 |
: @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h) |
537 |
: $img->scale (TW, TH) |
538 |
} |
539 |
|
540 |
sub resize($$$) { |
541 |
my $img = pop; |
542 |
$img->scale ($_[0], $_[1]) |
543 |
} |
544 |
|
545 |
sub fit($;$$) { |
546 |
my $img = pop; |
547 |
my $w = ($_[0] || TW) / $img->w; |
548 |
my $h = ($_[1] || TH) / $img->h; |
549 |
scale +(min $w, $h), $img |
550 |
} |
551 |
|
552 |
sub cover($;$$) { |
553 |
my $img = pop; |
554 |
my $w = ($_[0] || TW) / $img->w; |
555 |
my $h = ($_[1] || TH) / $img->h; |
556 |
scale +(max $w, $h), $img |
557 |
} |
558 |
|
559 |
=item move $dx, $dy, $img |
560 |
|
561 |
Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in |
562 |
the vertical. |
563 |
|
564 |
Example: move the image right by 20 pixels and down by 30. |
565 |
|
566 |
move 20, 30, ... |
567 |
|
568 |
=item align $xalign, $yalign, $img |
569 |
|
570 |
Aligns the image according to a factor - C<0> means the image is moved to |
571 |
the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is |
572 |
exactly centered and C<1> means it touches the right or bottom edge. |
573 |
|
574 |
Example: remove any visible border around an image, center it vertically but move |
575 |
it to the right hand side. |
576 |
|
577 |
align 1, 0.5, pad $img |
578 |
|
579 |
=item center $img |
580 |
|
581 |
=item center $width, $height, $img |
582 |
|
583 |
Centers the image, i.e. the center of the image is moved to the center of |
584 |
the terminal window (or the box specified by C<$width> and C<$height> if |
585 |
given). |
586 |
|
587 |
Example: load an image and center it. |
588 |
|
589 |
center pad load "mybg.png" |
590 |
|
591 |
=item rootalign $img |
592 |
|
593 |
Moves the image so that it appears glued to the screen as opposed to the |
594 |
window. This gives the illusion of a larger area behind the window. It is |
595 |
exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
596 |
top left of the screen. |
597 |
|
598 |
Example: load a background image, put it in mirror mode and root align it. |
599 |
|
600 |
rootalign mirror load "mybg.png" |
601 |
|
602 |
Example: take the screen background and align it, giving the illusion of |
603 |
transparency as long as the window isn't in front of other windows. |
604 |
|
605 |
rootalign root |
606 |
|
607 |
=cut |
608 |
|
609 |
sub move($$;$) { |
610 |
my $img = pop->clone; |
611 |
$img->move ($_[0], $_[1]); |
612 |
$img |
613 |
} |
614 |
|
615 |
sub align($;$$) { |
616 |
my $img = pop; |
617 |
|
618 |
move $_[0] * (TW - $img->w), |
619 |
$_[1] * (TH - $img->h), |
620 |
$img |
621 |
} |
622 |
|
623 |
sub center($;$$) { |
624 |
my $img = pop; |
625 |
my $w = $_[0] || TW; |
626 |
my $h = $_[1] || TH; |
627 |
|
628 |
move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img |
629 |
} |
630 |
|
631 |
sub rootalign($) { |
632 |
move -TX, -TY, $_[0] |
633 |
} |
634 |
|
635 |
=back |
636 |
|
637 |
=head2 COLOUR MODIFICATIONS |
638 |
|
639 |
The following operators change the pixels of the image. |
640 |
|
641 |
=over 4 |
642 |
|
643 |
=item contrast $factor, $img |
644 |
|
645 |
=item contrast $r, $g, $b, $img |
646 |
|
647 |
=item contrast $r, $g, $b, $a, $img |
648 |
|
649 |
Adjusts the I<contrast> of an image. |
650 |
|
651 |
The first form applies a single C<$factor> to red, green and blue, the |
652 |
second form applies separate factors to each colour channel, and the last |
653 |
form includes the alpha channel. |
654 |
|
655 |
Values from 0 to 1 lower the contrast, values higher than 1 increase the |
656 |
contrast. |
657 |
|
658 |
Due to limitations in the underlying XRender extension, lowering contrast |
659 |
also reduces brightness, while increasing contrast currently also |
660 |
increases brightness. |
661 |
|
662 |
=item brightness $bias, $img |
663 |
|
664 |
=item brightness $r, $g, $b, $img |
665 |
|
666 |
=item brightness $r, $g, $b, $a, $img |
667 |
|
668 |
Adjusts the brightness of an image. |
669 |
|
670 |
The first form applies a single C<$bias> to red, green and blue, the |
671 |
second form applies separate biases to each colour channel, and the last |
672 |
form includes the alpha channel. |
673 |
|
674 |
Values less than 0 reduce brightness, while values larger than 0 increase |
675 |
it. Useful range is from -1 to 1 - the former results in a black, the |
676 |
latter in a white picture. |
677 |
|
678 |
Due to idiosynchrasies in the underlying XRender extension, biases less |
679 |
than zero can be I<very> slow. |
680 |
|
681 |
=cut |
682 |
|
683 |
sub contrast($$;$$;$) { |
684 |
my $img = pop; |
685 |
my ($r, $g, $b, $a) = @_; |
686 |
|
687 |
($g, $b) = ($r, $r) if @_ < 3; |
688 |
$a = 1 if @_ < 4; |
689 |
|
690 |
$img = $img->clone; |
691 |
$img->contrast ($r, $g, $b, $a); |
692 |
$img |
693 |
} |
694 |
|
695 |
sub brightness($$;$$;$) { |
696 |
my $img = pop; |
697 |
my ($r, $g, $b, $a) = @_; |
698 |
|
699 |
($g, $b) = ($r, $r) if @_ < 3; |
700 |
$a = 1 if @_ < 4; |
701 |
|
702 |
$img = $img->clone; |
703 |
$img->brightness ($r, $g, $b, $a); |
704 |
$img |
705 |
} |
706 |
|
707 |
=item blur $radius, $img |
708 |
|
709 |
=item blur $radius_horz, $radius_vert, $img |
710 |
|
711 |
Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii |
712 |
can also be specified separately. |
713 |
|
714 |
Blurring is often I<very> slow, at least compared or other |
715 |
operators. Larger blur radii are slower than smaller ones, too, so if you |
716 |
don't want to freeze your screen for long times, start experimenting with |
717 |
low values for radius (<5). |
718 |
|
719 |
=cut |
720 |
|
721 |
sub blur($$;$) { |
722 |
my $img = pop; |
723 |
$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
724 |
} |
725 |
|
726 |
=item rotate $new_width, $new_height, $center_x, $center_y, $degrees |
727 |
|
728 |
Rotates the image by C<$degrees> degrees, counter-clockwise, around the |
729 |
pointer at C<$center_x> and C<$center_y> (specified as factor of image |
730 |
width/height), generating a new image with width C<$new_width> and height |
731 |
C<$new_height>. |
732 |
|
733 |
#TODO# new width, height, maybe more operators? |
734 |
|
735 |
Example: rotate the image by 90 degrees |
736 |
|
737 |
=cut |
738 |
|
739 |
sub rotate($$$$$$) { |
740 |
my $img = pop; |
741 |
$img->rotate ( |
742 |
$_[0], |
743 |
$_[1], |
744 |
$_[2] * $img->w, |
745 |
$_[3] * $img->h, |
746 |
$_[4] * (3.14159265 / 180), |
747 |
) |
748 |
} |
749 |
|
750 |
=back |
751 |
|
752 |
=cut |
753 |
|
754 |
} |
755 |
|
756 |
sub parse_expr { |
757 |
my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}"; |
758 |
die if $@; |
759 |
$expr |
760 |
} |
761 |
|
762 |
# compiles a parsed expression |
763 |
sub set_expr { |
764 |
my ($self, $expr) = @_; |
765 |
|
766 |
$self->{expr} = $expr; |
767 |
$self->recalculate; |
768 |
} |
769 |
|
770 |
# evaluate the current bg expression |
771 |
sub recalculate { |
772 |
my ($arg_self) = @_; |
773 |
|
774 |
# rate limit evaluation |
775 |
|
776 |
if ($arg_self->{next_refresh} > urxvt::NOW) { |
777 |
$arg_self->{next_refresh_timer} = urxvt::timer->new->after ($arg_self->{next_refresh} - urxvt::NOW)->cb (sub { |
778 |
$arg_self->recalculate; |
779 |
}); |
780 |
return; |
781 |
} |
782 |
|
783 |
$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
784 |
|
785 |
# set environment to evaluate user expression |
786 |
|
787 |
local $self = $arg_self; |
788 |
|
789 |
local $HOME = $ENV{HOME}; |
790 |
local $old = $self->{state}; |
791 |
local $new = my $state = $self->{state} = {}; |
792 |
|
793 |
($x, $y, $w, $h) = |
794 |
$self->background_geometry ($self->{border}); |
795 |
|
796 |
# evaluate user expression |
797 |
|
798 |
my $img = eval { $self->{expr}->() }; |
799 |
warn $@ if $@;#d# |
800 |
die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img"; |
801 |
|
802 |
$state->{size_sensitive} = 1 |
803 |
if $img->repeat_mode != urxvt::RepeatNormal; |
804 |
|
805 |
# if the expression is sensitive to external events, prepare reevaluation then |
806 |
|
807 |
my $repeat; |
808 |
|
809 |
if (my $again = $state->{again}) { |
810 |
$repeat = 1; |
811 |
my $self = $self; |
812 |
$state->{timer} = $again == $old->{again} |
813 |
? $old->{timer} |
814 |
: urxvt::timer->new->after ($again)->interval ($again)->cb (sub { |
815 |
++$self->{counter}; |
816 |
$self->recalculate |
817 |
}); |
818 |
} |
819 |
|
820 |
if (delete $state->{position_sensitive}) { |
821 |
$repeat = 1; |
822 |
$self->enable (position_change => sub { $_[0]->recalculate }); |
823 |
} else { |
824 |
$self->disable ("position_change"); |
825 |
} |
826 |
|
827 |
if (delete $state->{size_sensitive}) { |
828 |
$repeat = 1; |
829 |
$self->enable (size_change => sub { $_[0]->recalculate }); |
830 |
} else { |
831 |
$self->disable ("size_change"); |
832 |
} |
833 |
|
834 |
if (delete $state->{rootpmap_sensitive}) { |
835 |
$repeat = 1; |
836 |
$self->enable (rootpmap_change => sub { $_[0]->recalculate }); |
837 |
} else { |
838 |
$self->disable ("rootpmap_change"); |
839 |
} |
840 |
|
841 |
# clear stuff we no longer need |
842 |
|
843 |
%$old = (); |
844 |
|
845 |
unless ($repeat) { |
846 |
delete $self->{state}; |
847 |
delete $self->{expr}; |
848 |
} |
849 |
|
850 |
# set background pixmap |
851 |
|
852 |
$self->set_background ($img, $self->{border}); |
853 |
$self->scr_recolour (0); |
854 |
$self->want_refresh; |
855 |
} |
856 |
|
857 |
sub on_start { |
858 |
my ($self) = @_; |
859 |
|
860 |
my $expr = $self->x_resource ("%.expr") |
861 |
or return; |
862 |
|
863 |
$self->has_render |
864 |
or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; |
865 |
|
866 |
$self->set_expr (parse_expr $expr); |
867 |
$self->{border} = $self->x_resource_boolean ("%.border"); |
868 |
|
869 |
$MIN_INTERVAL = $self->x_resource ("%.interval"); |
870 |
|
871 |
() |
872 |
} |
873 |
|