ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
(Generate patch)

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.63 by root, Tue Jun 19 18:17:56 2012 UTC vs.
Revision 1.92 by sf-exg, Thu Jul 14 05:33:26 2016 UTC

1#! perl 1#! perl
2 2
3#:META:X_RESOURCE:%.expr:string:background expression 3#:META:RESOURCE:%.expr:string:background expression
4#:META:X_RESOURCE:%.border:boolean:respect the terminal border 4#:META:RESOURCE:%.border:boolean:respect the terminal border
5#:META:X_RESOURCE:%.interval:seconds:minimum time between updates 5#:META:RESOURCE:%.interval:seconds:minimum time between updates
6#:META:RESOURCE:pixmap:file[;geom]:set image as background
7#:META:RESOURCE:backgroundPixmap:file[;geom]:set image as background
8#:META:RESOURCE:tr:boolean:set root pixmap as background
9#:META:RESOURCE:transparent:boolean:set root pixmap as background
10#:META:RESOURCE:tint:color:tint background with color
11#:META:RESOURCE:tintColor:color:tint background with color
12#:META:RESOURCE:sh:number:shade background by number %
13#:META:RESOURCE:shading:number:shade background by number %
14#:META:RESOURCE:blr:HxV:gaussian-blur background with radii
15#:META:RESOURCE:blurRadius:HxV:gaussian-blur background with radii
6 16
7=head1 NAME 17=head1 NAME
8 18
9 background - manage terminal background 19background - manage terminal background
10 20
11=head1 SYNOPSIS 21=head1 SYNOPSIS
12 22
13 urxvt --background-expr 'background expression' 23 urxvt --background-expr 'background expression'
14 --background-border 24 --background-border
15 --background-interval seconds 25 --background-interval seconds
16 26
27=head1 QUICK AND DIRTY CHEAT SHEET
28
29Just load a random jpeg image and tile the background with it without
30scaling or anything else:
31
32 load "/path/to/img.jpg"
33
34The same, but use mirroring/reflection instead of tiling:
35
36 mirror load "/path/to/img.jpg"
37
38Load an image and scale it to exactly fill the terminal window:
39
40 scale keep { load "/path/to/img.jpg" }
41
42Implement pseudo-transparency by using a suitably-aligned root pixmap
43as window background:
44
45 rootalign root
46
47Likewise, but keep a blurred copy:
48
49 rootalign keep { blur 10, root }
50
17=head1 DESCRIPTION 51=head1 DESCRIPTION
18 52
19This extension manages the terminal background by creating a picture that 53This extension manages the terminal background by creating a picture that
20is behind the text, replacing the normal background colour. 54is behind the text, replacing the normal background colour.
21 55
26to be as simple as possible. 60to be as simple as possible.
27 61
28For example, to load an image and scale it to the window size, you would 62For example, to load an image and scale it to the window size, you would
29use: 63use:
30 64
31 urxvt --background-expr 'scale load "/path/to/mybg.png"' 65 urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
32 66
33Or specified as a X resource: 67Or specified as a X resource:
34 68
35 URxvt.background-expr: scale load "/path/to/mybg.png" 69 URxvt.background.expr: scale keep { load "/path/to/mybg.png" }
36 70
37=head1 THEORY OF OPERATION 71=head1 THEORY OF OPERATION
38 72
39At startup, just before the window is mapped for the first time, the 73At startup, just before the window is mapped for the first time, the
40expression is evaluated and must yield an image. The image is then 74expression is evaluated and must yield an image. The image is then
53If any of the parameters that the expression relies on changes (when the 87If any of the parameters that the expression relies on changes (when the
54window is moved or resized, its position or size changes; when the root 88window is moved or resized, its position or size changes; when the root
55pixmap is replaced by another one the root background changes; or when the 89pixmap is replaced by another one the root background changes; or when the
56timer elapses), then the expression will be evaluated again. 90timer elapses), then the expression will be evaluated again.
57 91
58For example, an expression such as C<scale load "$HOME/mybg.png"> scales the 92For example, an expression such as C<scale keep { load "$HOME/mybg.png"
59image to the window size, so it relies on the window size and will 93}> scales the image to the window size, so it relies on the window size
60be reevaluated each time it is changed, but not when it moves for 94and will be reevaluated each time it is changed, but not when it moves for
61example. That ensures that the picture always fills the terminal, even 95example. That ensures that the picture always fills the terminal, even
62after its size changes. 96after its size changes.
63 97
64=head2 EXPRESSIONS 98=head2 EXPRESSIONS
65 99
66Expressions are normal Perl expressions, in fact, they are Perl blocks - 100Expressions are normal Perl expressions, in fact, they are Perl blocks -
67which means you could use multiple lines and statements: 101which means you could use multiple lines and statements:
68 102
103 scale keep {
69 again 3600; 104 again 3600;
70 if (localtime now)[6]) { 105 if (localtime now)[6]) {
71 return scale load "$HOME/weekday.png"; 106 return load "$HOME/weekday.png";
72 } else { 107 } else {
73 return scale load "$HOME/sunday.png"; 108 return load "$HOME/sunday.png";
109 }
74 } 110 }
75 111
76This expression is evaluated once per hour. It will set F<sunday.png> as 112This inner expression is evaluated once per hour (and whenever the
113terminal window is resized). It sets F<sunday.png> as background on
77background on Sundays, and F<weekday.png> on all other days. 114Sundays, and F<weekday.png> on all other days.
78 115
79Fortunately, we expect that most expressions will be much simpler, with 116Fortunately, we expect that most expressions will be much simpler, with
80little Perl knowledge needed. 117little Perl knowledge needed.
81 118
82Basically, you always start with a function that "generates" an image 119Basically, you always start with a function that "generates" an image
105get a percentage): 142get a percentage):
106 143
107 scale 2, load "$HOME/mypic.png" 144 scale 2, load "$HOME/mypic.png"
108 145
109This enlarges the image by a factor of 2 (200%). As you can see, C<scale> 146This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
110has now two arguments, the C<200> and the C<load> expression, while 147has now two arguments, the C<2> and the C<load> expression, while
111C<load> only has one argument. Arguments are separated from each other by 148C<load> only has one argument. Arguments are separated from each other by
112commas. 149commas.
113 150
114Scale also accepts two arguments, which are then separate factors for both 151Scale also accepts two arguments, which are then separate factors for both
115horizontal and vertical dimensions. For example, this halves the image 152horizontal and vertical dimensions. For example, this halves the image
116width and doubles the image height: 153width and doubles the image height:
117 154
118 scale 0.5, 2, load "$HOME/mypic.png" 155 scale 0.5, 2, load "$HOME/mypic.png"
119 156
120Other effects than scaling are also readily available, for example, you can 157IF you try out these expressions, you might suffer from some sluggishness,
121tile the image to fill the whole window, instead of resizing it: 158because each time the terminal is resized, it loads the PNG image again
159and scales it. Scaling is usually fast (and unavoidable), but loading the
160image can be quite time consuming. This is where C<keep> comes in handy:
122 161
162 scale 0.5, 2, keep { load "$HOME/mypic.png" }
163
164The C<keep> operator executes all the statements inside the braces only
165once, or when it thinks the outcome might change. In other cases it
166returns the last value computed by the brace block.
167
168This means that the C<load> is only executed once, which makes it much
169faster, but also means that more memory is being used, because the loaded
170image must be kept in memory at all times. In this expression, the
171trade-off is likely worth it.
172
173But back to effects: Other effects than scaling are also readily
174available, for example, you can tile the image to fill the whole window,
175instead of resizing it:
176
123 tile load "$HOME/mypic.png" 177 tile keep { load "$HOME/mypic.png" }
124 178
125In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator 179In fact, images returned by C<load> are in C<tile> mode by default, so the
126is kind of superfluous. 180C<tile> operator is kind of superfluous.
127 181
128Another common effect is to mirror the image, so that the same edges touch: 182Another common effect is to mirror the image, so that the same edges
183touch:
129 184
130 mirror load "$HOME/mypic.png" 185 mirror keep { load "$HOME/mypic.png" }
131 186
132This is also a typical background expression: 187Another common background expression is:
133 188
134 rootalign root 189 rootalign root
135 190
136It first takes a snapshot of the screen background image, and then 191This one first takes a snapshot of the screen background image, and then
137moves it to the upper left corner of the screen - the result is 192moves it to the upper left corner of the screen (as opposed to the upper
138pseudo-transparency, as the image seems to be static while the window is 193left corner of the terminal window)- the result is pseudo-transparency:
139moved around. 194the image seems to be static while the window is moved around.
140 195
141=head2 CYCLES AND CACHING 196=head2 COLOUR SPECIFICATIONS
142 197
143=head3 C<load> et al. 198Whenever an operator expects a "colour", then this can be specified in one
199of two ways: Either as string with an X11 colour specification, such as:
144 200
145As has been mentioned before, the expression might be evaluated multiple 201 "red" # named colour
146times. Each time the expression is reevaluated, a new cycle is said to 202 "#f00" # simple rgb
147have begun. Many operators cache their results till the next cycle. 203 "[50]red" # red with 50% alpha
204 "TekHVC:300/50/50" # anything goes
148 205
149For example, the C<load> operator keeps a copy of the image. If it is 206OR as an array reference with one, three or four components:
150asked to load the same image on the next cycle it will not load it again,
151but return the cached copy.
152 207
153This only works for one cycle though, so as long as you load the same 208 [0.5] # 50% gray, 100% alpha
154image every time, it will always be cached, but when you load a different 209 [0.5, 0, 0] # dark red, no green or blur, 100% alpha
155image, it will forget about the first one. 210 [0.5, 0, 0, 0.7] # same with explicit 70% alpha
156 211
157This allows you to either speed things up by keeping multiple images in 212=head2 CACHING AND SENSITIVITY
158memory, or conserve memory by loading images more often.
159 213
160For example, you can keep two images in memory and use a random one like 214Since some operations (such as C<load> and C<blur>) can take a long time,
161this: 215caching results can be very important for a smooth operation. Caching can
216also be useful to reduce memory usage, though, for example, when an image
217is cached by C<load>, it could be shared by multiple terminal windows
218running inside urxvtd.
162 219
163 my $img1 = load "img1.png"; 220=head3 C<keep { ... }> caching
164 my $img2 = load "img2.png";
165 (0.5 > rand) ? $img1 : $img2
166 221
167Since both images are "loaded" every time the expression is evaluated, 222The most important way to cache expensive operations is to use C<keep {
168they are always kept in memory. Contrast this version:
169
170 my $path1 = "img1.png";
171 my $path2 = "img2.png";
172 load ((0.5 > rand) ? $path1 : $path2)
173
174Here, a path is selected randomly, and load is only called for one image,
175so keeps only one image in memory. If, on the next evaluation, luck
176decides to use the other path, then it will have to load that image again.
177
178=head3 C<once { ... }>
179
180Another way to cache expensive operations is to use C<once { ... }>. The
181C<once> operator takes a block of multiple statements enclosed by C<{}> 223... }>. The C<keep> operator takes a block of multiple statements enclosed
182and evaluates it only.. once, returning any images the last statement 224by C<{}> and keeps the return value in memory.
183returned. Further calls simply produce the values from the cache.
184 225
226An expression can be "sensitive" to various external events, such as
227scaling or moving the window, root background changes and timers. Simply
228using an expression (such as C<scale> without parameters) that depends on
229certain changing values (called "variables"), or using those variables
230directly, will make an expression sensitive to these events - for example,
231using C<scale> or C<TW> will make the expression sensitive to the terminal
232size, and thus to resizing events.
233
234When such an event happens, C<keep> will automatically trigger a
235reevaluation of the whole expression with the new value of the expression.
236
185This is most useful for expensive operations, such as C<blur>: 237C<keep> is most useful for expensive operations, such as C<blur>:
186 238
187 rootalign once { blur 20, root } 239 rootalign keep { blur 20, root }
188 240
189This makes a blurred copy of the root background once, and on subsequent 241This makes a blurred copy of the root background once, and on subsequent
190calls, just root-aligns it. Since C<blur> is usually quite slow and 242calls, just root-aligns it. Since C<blur> is usually quite slow and
191C<rootalign> is quite fast, this trades extra memory (For the cached 243C<rootalign> is quite fast, this trades extra memory (for the cached
192blurred pixmap) with speed (blur only needs to be redone when root 244blurred pixmap) with speed (blur only needs to be redone when root
193changes). 245changes).
246
247=head3 C<load> caching
248
249The C<load> operator itself does not keep images in memory, but as long as
250the image is still in memory, C<load> will use the in-memory image instead
251of loading it freshly from disk.
252
253That means that this expression:
254
255 keep { load "$HOME/path..." }
256
257Not only caches the image in memory, other terminal instances that try to
258C<load> it can reuse that in-memory copy.
194 259
195=head1 REFERENCE 260=head1 REFERENCE
196 261
197=head2 COMMAND LINE SWITCHES 262=head2 COMMAND LINE SWITCHES
198 263
224=cut 289=cut
225 290
226our %_IMG_CACHE; 291our %_IMG_CACHE;
227our $HOME; 292our $HOME;
228our ($self, $frame); 293our ($self, $frame);
229our ($x, $y, $w, $h); 294our ($x, $y, $w, $h, $focus);
230 295
231# enforce at least this interval between updates 296# enforce at least this interval between updates
232our $MIN_INTERVAL = 6/59.951; 297our $MIN_INTERVAL = 6/59.951;
233 298
234{ 299{
252=item load $path 317=item load $path
253 318
254Loads the image at the given C<$path>. The image is set to plane tiling 319Loads the image at the given C<$path>. The image is set to plane tiling
255mode. 320mode.
256 321
257Loaded images will be cached for one cycle, and shared between temrinals 322If the image is already in memory (e.g. because another terminal instance
258running in the same process (e.g. in C<urxvtd>). 323uses it), then the in-memory copy is returned instead.
259 324
260#=item load_uc $path 325=item load_uc $path
261# 326
262#Load uncached - same as load, but does not cache the image. This function 327Load uncached - same as load, but does not cache the image, which means it
263#is most useufl if you want to optimise a background expression in some 328is I<always> loaded from the filesystem again, even if another copy of it
264#way. 329is in memory at the time.
265 330
266=cut 331=cut
332
333 sub load_uc($) {
334 $self->new_img_from_file ($_[0])
335 }
267 336
268 sub load($) { 337 sub load($) {
269 my ($path) = @_; 338 my ($path) = @_;
270 339
271 $_IMG_CACHE{$path} || do { 340 $_IMG_CACHE{$path} || do {
272 my $img = $self->new_img_from_file ($path); 341 my $img = load_uc $path;
273 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); 342 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
274 $img 343 $img
275 } 344 }
276 } 345 }
277 346
323 392
324=item merge $img ... 393=item merge $img ...
325 394
326Takes any number of images and merges them together, creating a single 395Takes any number of images and merges them together, creating a single
327image containing them all. The tiling mode of the first image is used as 396image containing them all. The tiling mode of the first image is used as
328the tiling mdoe of the resulting image. 397the tiling mode of the resulting image.
329 398
330This function is called automatically when an expression returns multiple 399This function is called automatically when an expression returns multiple
331images. 400images.
332 401
333=cut 402=cut
362 $base->draw ($_) 431 $base->draw ($_)
363 for @_; 432 for @_;
364 433
365 $base 434 $base
366 } 435 }
436
437=back
367 438
368=head2 TILING MODES 439=head2 TILING MODES
369 440
370The following operators modify the tiling mode of an image, that is, the 441The following operators modify the tiling mode of an image, that is, the
371way that pixels outside the image area are painted when the image is used. 442way that pixels outside the image area are painted when the image is used.
463 534
464Return the X and Y coordinates of the terminal window (the terminal 535Return the X and Y coordinates of the terminal window (the terminal
465window is the full window by default, and the character area only when in 536window is the full window by default, and the character area only when in
466border-respect mode). 537border-respect mode).
467 538
468Using these functions make your expression sensitive to window moves. 539Using these functions makes your expression sensitive to window moves.
469 540
470These functions are mainly useful to align images to the root window. 541These functions are mainly useful to align images to the root window.
471 542
472Example: load an image and align it so it looks as if anchored to the 543Example: load an image and align it so it looks as if anchored to the
473background. 544background (that's exactly what C<rootalign> does btw.):
474 545
475 move -TX, -TY, load "mybg.png" 546 move -TX, -TY, keep { load "mybg.png" }
476 547
477=item TW 548=item TW
549
550=item TH
478 551
479Return the width (C<TW>) and height (C<TH>) of the terminal window (the 552Return the width (C<TW>) and height (C<TH>) of the terminal window (the
480terminal window is the full window by default, and the character area only 553terminal window is the full window by default, and the character area only
481when in border-respect mode). 554when in border-respect mode).
482 555
483Using these functions make your expression sensitive to window resizes. 556Using these functions makes your expression sensitive to window resizes.
484 557
485These functions are mainly useful to scale images, or to clip images to 558These functions are mainly useful to scale images, or to clip images to
486the window size to conserve memory. 559the window size to conserve memory.
487 560
488Example: take the screen background, clip it to the window size, blur it a 561Example: take the screen background, clip it to the window size, blur it a
489bit, align it to the window position and use it as background. 562bit, align it to the window position and use it as background.
490 563
491 clip move -TX, -TY, once { blur 5, root } 564 clip move -TX, -TY, keep { blur 5, root }
492 565
493=cut 566=item FOCUS
494 567
568Returns a boolean indicating whether the terminal window has keyboard
569focus, in which case it returns true.
570
571Using this function makes your expression sensitive to focus changes.
572
573A common use case is to fade the background image when the terminal loses
574focus, often together with the C<-fade> command line option. In fact,
575there is a special function for just that use case: C<focus_fade>.
576
577Example: use two entirely different background images, depending on
578whether the window has focus.
579
580 FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" }
581
582=cut
583
495 sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } 584 sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
496 sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } 585 sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
497 sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } 586 sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
498 sub TH() { $frame->[FR_AGAIN]{size} = 1; $h } 587 sub TH () { $frame->[FR_AGAIN]{size} = 1; $h }
588 sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus }
499 589
500=item now 590=item now
501 591
502Returns the current time as (fractional) seconds since the epoch. 592Returns the current time as (fractional) seconds since the epoch.
503 593
510C<$seconds> seconds. 600C<$seconds> seconds.
511 601
512Example: load some image and rotate it according to the time of day (as if it were 602Example: load some image and rotate it according to the time of day (as if it were
513the hour pointer of a clock). Update this image every minute. 603the hour pointer of a clock). Update this image every minute.
514 604
605 again 60;
515 again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" 606 rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
516 607
517=item counter $seconds 608=item counter $seconds
518 609
519Like C<again>, but also returns an increasing counter value, starting at 610Like C<again>, but also returns an increasing counter value, starting at
5200, which might be useful for some simple animation effects. 6110, which might be useful for some simple animation effects.
549Clips an image to the given rectangle. If the rectangle is outside the 640Clips an image to the given rectangle. If the rectangle is outside the
550image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is 641image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
551larger than the image, then the tiling mode defines how the extra pixels 642larger than the image, then the tiling mode defines how the extra pixels
552will be filled. 643will be filled.
553 644
554If C<$x> an C<$y> are missing, then C<0> is assumed for both. 645If C<$x> and C<$y> are missing, then C<0> is assumed for both.
555 646
556If C<$width> and C<$height> are missing, then the window size will be 647If C<$width> and C<$height> are missing, then the window size will be
557assumed. 648assumed.
558 649
559Example: load an image, blur it, and clip it to the window size to save 650Example: load an image, blur it, and clip it to the window size to save
560memory. 651memory.
561 652
562 clip blur 10, load "mybg.png" 653 clip keep { blur 10, load "mybg.png" }
563 654
564=cut 655=cut
565 656
566 sub clip($;$$;$$) { 657 sub clip($;$$;$$) {
567 my $img = pop; 658 my $img = pop;
577=item scale $width_factor, $height_factor, $img 668=item scale $width_factor, $height_factor, $img
578 669
579Scales the image by the given factors in horizontal 670Scales the image by the given factors in horizontal
580(C<$width>) and vertical (C<$height>) direction. 671(C<$width>) and vertical (C<$height>) direction.
581 672
582If only one factor is give, it is used for both directions. 673If only one factor is given, it is used for both directions.
583 674
584If no factors are given, scales the image to the window size without 675If no factors are given, scales the image to the window size without
585keeping aspect. 676keeping aspect.
586 677
587=item resize $width, $height, $img 678=item resize $width, $height, $img
661the terminal window (or the box specified by C<$width> and C<$height> if 752the terminal window (or the box specified by C<$width> and C<$height> if
662given). 753given).
663 754
664Example: load an image and center it. 755Example: load an image and center it.
665 756
666 center pad load "mybg.png" 757 center keep { pad load "mybg.png" }
667 758
668=item rootalign $img 759=item rootalign $img
669 760
670Moves the image so that it appears glued to the screen as opposed to the 761Moves the image so that it appears glued to the screen as opposed to the
671window. This gives the illusion of a larger area behind the window. It is 762window. This gives the illusion of a larger area behind the window. It is
672exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the 763exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
673top left of the screen. 764top left of the screen.
674 765
675Example: load a background image, put it in mirror mode and root align it. 766Example: load a background image, put it in mirror mode and root align it.
676 767
677 rootalign mirror load "mybg.png" 768 rootalign keep { mirror load "mybg.png" }
678 769
679Example: take the screen background and align it, giving the illusion of 770Example: take the screen background and align it, giving the illusion of
680transparency as long as the window isn't in front of other windows. 771transparency as long as the window isn't in front of other windows.
681 772
682 rootalign root 773 rootalign root
707 798
708 sub rootalign($) { 799 sub rootalign($) {
709 move -TX, -TY, $_[0] 800 move -TX, -TY, $_[0]
710 } 801 }
711 802
712=item rotate $center_x, $center_y, $degrees 803=item rotate $center_x, $center_y, $degrees, $img
713 804
714Rotates the image by C<$degrees> degrees, counter-clockwise, around the 805Rotates the image clockwise by C<$degrees> degrees, around the point at
715pointer at C<$center_x> and C<$center_y> (specified as factor of image 806C<$center_x> and C<$center_y> (specified as factor of image width/height).
716width/height).
717 807
718#TODO# new width, height, maybe more operators?
719
720Example: rotate the image by 90 degrees 808Example: rotate the image by 90 degrees around its center.
809
810 rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
721 811
722=cut 812=cut
723 813
724 sub rotate($$$$) { 814 sub rotate($$$$) {
725 my $img = pop; 815 my $img = pop;
736 826
737The following operators change the pixels of the image. 827The following operators change the pixels of the image.
738 828
739=over 4 829=over 4
740 830
831=item tint $color, $img
832
833Tints the image in the given colour.
834
835Example: tint the image red.
836
837 tint "red", load "rgb.png"
838
839Example: the same, but specify the colour by component.
840
841 tint [1, 0, 0], load "rgb.png"
842
843=cut
844
845 sub tint($$) {
846 $_[1]->tint ($_[0])
847 }
848
849=item shade $factor, $img
850
851Shade the image by the given factor.
852
853=cut
854
855 sub shade($$) {
856 $_[1]->shade ($_[0])
857 }
858
741=item contrast $factor, $img 859=item contrast $factor, $img
742 860
743=item contrast $r, $g, $b, $img 861=item contrast $r, $g, $b, $img
744 862
745=item contrast $r, $g, $b, $a, $img 863=item contrast $r, $g, $b, $a, $img
774latter in a white picture. 892latter in a white picture.
775 893
776Due to idiosyncrasies in the underlying XRender extension, biases less 894Due to idiosyncrasies in the underlying XRender extension, biases less
777than zero can be I<very> slow. 895than zero can be I<very> slow.
778 896
897You can also try the experimental(!) C<muladd> operator.
898
779=cut 899=cut
780 900
781 sub contrast($$;$$;$) { 901 sub contrast($$;$$;$) {
782 my $img = pop; 902 my $img = pop;
783 my ($r, $g, $b, $a) = @_; 903 my ($r, $g, $b, $a) = @_;
798 $a = 1 if @_ < 4; 918 $a = 1 if @_ < 4;
799 919
800 $img = $img->clone; 920 $img = $img->clone;
801 $img->brightness ($r, $g, $b, $a); 921 $img->brightness ($r, $g, $b, $a);
802 $img 922 $img
923 }
924
925=item muladd $mul, $add, $img # EXPERIMENTAL
926
927First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used
928to implement brightness and contrast at the same time, with a wider value
929range than contrast and brightness operators.
930
931Due to numerous bugs in XRender implementations, it can also introduce a
932number of visual artifacts.
933
934Example: increase contrast by a factor of C<$c> without changing image
935brightness too much.
936
937 muladd $c, (1 - $c) * 0.5, $img
938
939=cut
940
941 sub muladd($$$) {
942 $_[2]->muladd ($_[0], $_[1])
803 } 943 }
804 944
805=item blur $radius, $img 945=item blur $radius, $img
806 946
807=item blur $radius_horz, $radius_vert, $img 947=item blur $radius_horz, $radius_vert, $img
819 sub blur($$;$) { 959 sub blur($$;$) {
820 my $img = pop; 960 my $img = pop;
821 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) 961 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
822 } 962 }
823 963
964=item focus_fade $img
965
966=item focus_fade $factor, $img
967
968=item focus_fade $factor, $color, $img
969
970Fades the image by the given factor (and colour) when focus is lost (the
971same as the C<-fade>/C<-fadecolor> command line options, which also supply
972the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
973C<$factor> is a real value, not a percentage value (that is, 0..1, not
9740..100).
975
976Example: do the right thing when focus fading is requested.
977
978 focus_fade load "mybg.jpg";
979
980=cut
981
982 sub focus_fade($;$$) {
983 my $img = pop;
984
985 return $img
986 if FOCUS;
987
988 my $fade = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0;
989 my $color = @_ >= 2 ? $_[1] : $self->resource ("color+" . urxvt::Color_fade);
990
991 $img = $img->tint ($color) if $color ne "rgb:00/00/00";
992 $img = $img->muladd (1 - $fade, 0) if $fade;
993
994 $img
995 }
996
824=back 997=back
825 998
826=head2 OTHER STUFF 999=head2 OTHER STUFF
827 1000
828Anything that didn't fit any of the other categories, even after applying 1001Anything that didn't fit any of the other categories, even after applying
829force and closing our eyes. 1002force and closing our eyes.
830 1003
831=over 4 1004=over 4
832 1005
833=item once { ... } 1006=item keep { ... }
834 1007
835This function takes a code block as argument, that is, one or more 1008This operator takes a code block as argument, that is, one or more
836statements enclosed by braces. 1009statements enclosed by braces.
837 1010
838The trick is that this code block is only evaluated once - future calls 1011The trick is that this code block is only evaluated when the outcome
839will simply return the original image (yes, it should only be used with 1012changes - on other calls the C<keep> simply returns the image it computed
840images). 1013previously (yes, it should only be used with images). Or in other words,
1014C<keep> I<caches> the result of the code block so it doesn't need to be
1015computed again.
841 1016
842This can be extremely useful to avoid redoing the same slow operations 1017This can be extremely useful to avoid redoing slow operations - for
843again and again- for example, if your background expression takes the root 1018example, if your background expression takes the root background, blurs it
844background, blurs it and then root-aligns it it would have to blur the 1019and then root-aligns it it would have to blur the root background on every
845root background on every window move or resize. 1020window move or resize.
1021
1022Another example is C<load>, which can be quite slow.
846 1023
847In fact, urxvt itself encloses the whole expression in some kind of 1024In fact, urxvt itself encloses the whole expression in some kind of
848C<once> block so it only is reevaluated as required. 1025C<keep> block so it only is reevaluated as required.
849 1026
850Putting the blur into a C<once> block will make sure the blur is only done 1027Putting the blur into a C<keep> block will make sure the blur is only done
851once: 1028once, while the C<rootalign> is still done each time the window moves.
852 1029
853 rootlign once { blur 10, root } 1030 rootalign keep { blur 10, root }
854 1031
855This leaves the question of how to force reevaluation of the block, 1032This leaves the question of how to force reevaluation of the block,
856in case the root background changes: If expression inside the block 1033in case the root background changes: If expression inside the block
857is sensitive to some event (root background changes, window geometry 1034is sensitive to some event (root background changes, window geometry
858changes), then it will be reevaluated automatically as needed. 1035changes), then it will be reevaluated automatically as needed.
859 1036
860=item once_again 1037=back
861 1038
862Resets all C<once> block as if they had never been called, i.e. on the 1039=head1 OLD BACKGROUND IMAGE SETTINGS
863next call they will be reevaluated again.
864 1040
865=cut 1041This extension also provides support for the old options/resources and
1042OSC sequences for setting a background image. These settings are
1043B<deprecated> and will be removed in future versions.
866 1044
1045=head2 OPTIONS AND RESOURCES
1046
1047=over 4
1048
1049=item B<-pixmap> I<file[;oplist]>
1050
1051=item B<backgroundPixmap:> I<file[;oplist]>
1052
1053Use the specified image file as the window's background and also
1054optionally specify a colon separated list of operations to modify it.
1055Note that you may need to quote the C<;> character when using the
1056command line option, as C<;> is usually a metacharacter in shells.
1057Supported operations are:
1058
1059=over 4
1060
1061=item B<WxH+X+Y>
1062
1063sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1064scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1065scale of 0 disables scaling.
1066
1067=item B<op=tile>
1068
1069enables tiling
1070
1071=item B<op=keep-aspect>
1072
1073maintain the image aspect ratio when scaling
1074
1075=item B<op=root-align>
1076
1077use the position of the terminal window relative to the root window as
1078the image offset, simulating a root window background
1079
1080=back
1081
1082The default scale and position setting is C<100x100+50+50>.
1083Alternatively, a predefined set of templates can be used to achieve
1084the most common setups:
1085
1086=over 4
1087
1088=item B<style=tiled>
1089
1090the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1091
1092=item B<style=aspect-stretched>
1093
1094the image is scaled to fill the whole window maintaining the aspect
1095ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1096
1097=item B<style=stretched>
1098
1099the image is scaled to fill the whole window. Equivalent to 100x100
1100
1101=item B<style=centered>
1102
1103the image is centered with no scaling. Equivalent to 0x0+50+50
1104
1105=item B<style=root-tiled>
1106
1107the image is tiled with no scaling and using 'root' positioning.
1108Equivalent to 0x0:op=tile:op=root-align
1109
1110=back
1111
1112If multiple templates are specified the last one wins. Note that a
1113template overrides all the scale, position and operations settings.
1114
1115If used in conjunction with pseudo-transparency, the specified image
1116will be blended over the transparent background using alpha-blending.
1117
1118=item B<-tr>|B<+tr>
1119
1120=item B<transparent:> I<boolean>
1121
1122Turn on/off pseudo-transparency by using the root pixmap as background.
1123
1124=item B<-tint> I<colour>
1125
1126=item B<tintColor:> I<colour>
1127
1128Tint the transparent background with the given colour. Note that a
1129black tint yields a completely black image while a white tint yields
1130the image unchanged.
1131
1132=item B<-sh> I<number>
1133
1134=item B<shading:> I<number>
1135
1136Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1137A value of 100 means no shading.
1138
1139=item B<-blr> I<HxV>
1140
1141=item B<blurRadius:> I<HxV>
1142
1143Apply gaussian blur with the specified radius to the transparent
1144background. If a single number is specified, the vertical and
1145horizontal radii are considered to be the same. Setting one of the
1146radii to 1 and the other to a large number creates interesting effects
1147on some backgrounds. The maximum radius value is 128. An horizontal or
1148vertical radius of 0 disables blurring.
1149
1150=back
1151
1152=head2 OSC sequences
1153
1154=over 4
1155
1156=item B<< C<ESC ] 705 ; Pt ST> >> Change transparent background tint colour to B<< C<Pt> >>.
1157
1158=item B<< C<ESC ] 20 ; Pt ST> >> Change/Query background image
1159parameters: the value of B<< C<Pt> >> can be one of the following
1160commands:
1161
1162=over 4
1163
1164=item B<< C<?> >>
1165
1166display scale and position in the title
1167
1168=item B<< C<;WxH+X+Y> >>
1169
1170change scale and/or position
1171
1172=item B<< C<FILE;WxH+X+Y> >>
1173
1174change background image
1175
1176=back
1177
1178=cut
1179
867 sub once(&) { 1180 sub keep(&) {
868 my $id = $_[0]+0; 1181 my $id = $_[0]+0;
869 1182
870 local $frame = $self->{frame_cache}{$id} ||= [$frame]; 1183 local $frame = $self->{frame_cache}{$id} ||= [$frame];
871 1184
872 unless ($frame->[FR_CACHE]) { 1185 unless ($frame->[FR_CACHE]) {
879 # clear this frame cache, also for all parents 1192 # clear this frame cache, also for all parents
880 for (my $frame = $frame; $frame; $frame = $frame->[0]) { 1193 for (my $frame = $frame; $frame; $frame = $frame->[0]) {
881 undef $frame->[FR_CACHE]; 1194 undef $frame->[FR_CACHE];
882 } 1195 }
883 1196
884 unless ($self->{term}) {
885 use Data::Dump;
886 ddx $frame;
887 exit;
888 }
889
890 $self->recalculate; 1197 $self->recalculate;
891 }); 1198 });
892 }; 1199 };
893 1200
894 # in scalar context we always return the first original result, which 1201 # in scalar context we always return the first original result, which
896 wantarray 1203 wantarray
897 ? @{ $frame->[FR_CACHE] } 1204 ? @{ $frame->[FR_CACHE] }
898 : $frame->[FR_CACHE][0] 1205 : $frame->[FR_CACHE][0]
899 } 1206 }
900 1207
901 sub once_again() { 1208# sub keep_clear() {
902 delete $self->{frame_cache}; 1209# delete $self->{frame_cache};
903 } 1210# }
904 1211
905=back 1212=back
906 1213
907=cut 1214=cut
908 1215
921 1228
922# compiles a parsed expression 1229# compiles a parsed expression
923sub set_expr { 1230sub set_expr {
924 my ($self, $expr) = @_; 1231 my ($self, $expr) = @_;
925 1232
926 $self->{root} = []; 1233 $self->{root} = []; # the outermost frame
927 $self->{expr} = $expr; 1234 $self->{expr} = $expr;
928 $self->recalculate; 1235 $self->recalculate;
929} 1236}
930 1237
931# takes a hash of sensitivity indicators and installs watchers 1238# takes a hash of sensitivity indicators and installs watchers
972 if ($again->{rootpmap}) { 1279 if ($again->{rootpmap}) {
973 $state->{rootpmap} = $self->on (rootpmap_change => $cb); 1280 $state->{rootpmap} = $self->on (rootpmap_change => $cb);
974 } else { 1281 } else {
975 delete $state->{rootpmap}; 1282 delete $state->{rootpmap};
976 } 1283 }
1284
1285 if ($again->{focus}) {
1286 $state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
1287 } else {
1288 delete $state->{focus};
1289 }
977} 1290}
978 1291
979# evaluate the current bg expression 1292# evaluate the current bg expression
980sub recalculate { 1293sub recalculate {
981 my ($arg_self) = @_; 1294 my ($arg_self) = @_;
993 1306
994 # set environment to evaluate user expression 1307 # set environment to evaluate user expression
995 1308
996 local $self = $arg_self; 1309 local $self = $arg_self;
997 local $HOME = $ENV{HOME}; 1310 local $HOME = $ENV{HOME};
998 local $frame = []; 1311 local $frame = $self->{root};
999 1312
1000 ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); 1313 ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
1314 $focus = $self->focus;
1001 1315
1002 # evaluate user expression 1316 # evaluate user expression
1003 1317
1004 my @img = eval { $self->{expr}->() }; 1318 my @img = eval { $self->{expr}->() };
1005 die $@ if $@; 1319 die $@ if $@;
1023# } 1337# }
1024 1338
1025 # set background pixmap 1339 # set background pixmap
1026 1340
1027 $self->set_background ($img, $self->{border}); 1341 $self->set_background ($img, $self->{border});
1028 $self->scr_recolour (0); 1342 $self->scr_recolor (0);
1029 $self->want_refresh; 1343 $self->want_refresh;
1030} 1344}
1031 1345
1346sub old_bg_opts {
1347 my ($self, $arg) = @_;
1348
1349 $arg or return;
1350
1351 my @str = split /;/, $arg;
1352
1353 return unless $str[0] or $self->{bg_opts}->{path};
1354
1355 my $bg_opts = $self->{bg_opts};
1356
1357 if ($str[0]) {
1358 $bg_opts->{tile} = 0;
1359 $bg_opts->{keep_aspect} = 0;
1360 $bg_opts->{root_align} = 0;
1361 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1362 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1363 $bg_opts->{path} = unpack "H*", $str[0];
1364 }
1365
1366 my @oplist = split /:/, $str[1];
1367
1368 for (@oplist) {
1369 if (/style=tiled/i) {
1370 $bg_opts->{tile} = 1;
1371 $bg_opts->{keep_aspect} = 0;
1372 $bg_opts->{root_align} = 0;
1373 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1374 $bg_opts->{h_align} = $bg_opts->{v_align} = 0;
1375 } elsif (/style=aspect-stretched/i) {
1376 $bg_opts->{tile} = 0;
1377 $bg_opts->{keep_aspect} = 1;
1378 $bg_opts->{root_align} = 0;
1379 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1380 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1381 } elsif (/style=stretched/i) {
1382 $bg_opts->{tile} = 0;
1383 $bg_opts->{keep_aspect} = 0;
1384 $bg_opts->{root_align} = 0;
1385 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1386 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1387 } elsif (/style=centered/i) {
1388 $bg_opts->{tile} = 0;
1389 $bg_opts->{keep_aspect} = 0;
1390 $bg_opts->{root_align} = 0;
1391 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1392 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1393 } elsif (/style=root-tiled/i) {
1394 $bg_opts->{tile} = 1;
1395 $bg_opts->{keep_aspect} = 0;
1396 $bg_opts->{root_align} = 1;
1397 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1398 $bg_opts->{h_align} = $bg_opts->{v_align} = 0;
1399 } elsif (/op=tile/i) {
1400 $bg_opts->{tile} = 1;
1401 } elsif (/op=keep_aspect/i) {
1402 $bg_opts->{keep_aspect} = 1;
1403 } elsif (/op=root_align/i) {
1404 $bg_opts->{root_align} = 1;
1405 } elsif (/^ =? ([0-9]+)? (?:[xX] ([0-9]+))? ([+-][0-9]+)? ([+-][0-9]+)? $/x) {
1406 my ($w, $h, $x, $y) = ($1, $2, $3, $4);
1407
1408 if ($str[0]) {
1409 $w = $h unless defined $w;
1410 $h = $w unless defined $h;
1411 $y = $x unless defined $y;
1412 }
1413
1414 $bg_opts->{h_scale} = $w if defined $w;
1415 $bg_opts->{v_scale} = $h if defined $h;
1416 $bg_opts->{h_align} = $x if defined $x;
1417 $bg_opts->{v_align} = $y if defined $y;
1418 }
1419 }
1420}
1421
1422sub old_bg_expr {
1423 my ($self) = @_;
1424
1425 my $expr;
1426
1427 my $bg_opts = $self->{bg_opts};
1428
1429 if ($bg_opts->{root}) {
1430 $expr .= "tile (";
1431
1432 my $shade = $bg_opts->{shade};
1433
1434 if ($shade) {
1435 $shade = List::Util::min $shade, 200;
1436 $shade = List::Util::max $shade, -100;
1437 $shade = 200 - (100 + $shade) if $shade < 0;
1438
1439 $shade = $shade * 0.01 - 1;
1440 $expr .= "shade $shade, ";
1441 }
1442
1443 my $tint = $bg_opts->{tint};
1444
1445 if ($tint) {
1446 $expr .= "tint $tint, ";
1447 }
1448
1449 my $blur = $bg_opts->{blur};
1450
1451 if ($blur and $blur =~ /^ =? ([0-9]+)? (?:[xX] ([0-9]+))? $/x) {
1452 my $hr = defined $1 ? $1 : 1;
1453 my $vr = defined $2 ? $2 : $hr;
1454
1455 if ($hr != 0 and $vr != 0) {
1456 $expr .= "blur $hr, $vr, ";
1457 }
1458 }
1459
1460 $expr .= "rootalign root)";
1461 }
1462
1463 if ($bg_opts->{path}) {
1464 my $file_expr;
1465 my $h_scale = $bg_opts->{h_scale} * 0.01;
1466 my $v_scale = $bg_opts->{v_scale} * 0.01;
1467 my $h_align = $bg_opts->{h_align} * 0.01;
1468 my $v_align = $bg_opts->{v_align} * 0.01;
1469
1470 if (!$bg_opts->{tile}) {
1471 $file_expr .= "pad (";
1472 } else {
1473 $file_expr .= "tile (";
1474 }
1475
1476 if ($bg_opts->{root_align}) {
1477 $file_expr .= "rootalign ";
1478 } else {
1479 $file_expr .= "align $h_align, $v_align, ";
1480 }
1481
1482 if ($h_scale != 0 and $v_scale != 0) {
1483 my $op = $bg_opts->{keep_aspect} ? "fit" : "resize";
1484 $file_expr .= "$op TW * $h_scale, TH * $v_scale, ";
1485 }
1486
1487 $file_expr .= "keep { load pack \"H*\", \"$bg_opts->{path}\" })";
1488
1489 if ($expr) {
1490 $expr .= ", tint (\"[50]white\", $file_expr)";
1491 } else {
1492 $expr = $file_expr;
1493 }
1494 }
1495
1496 $expr
1497}
1498
1499sub on_osc_seq {
1500 my ($self, $op, $arg) = @_;
1501
1502 $self->{bg_opts} or return;
1503
1504 $op =~ /^(20|705)$/ or return;
1505
1506 if ($op eq "20") {
1507 if ($arg eq "?") {
1508 my $h_scale = $self->{bg_opts}->{h_scale};
1509 my $v_scale = $self->{bg_opts}->{v_scale};
1510 my $h_align = $self->{bg_opts}->{h_align};
1511 my $v_align = $self->{bg_opts}->{v_align};
1512 $self->cmd_parse ("\033]2;[${h_scale}x${v_scale}+${h_align}+${v_align}]\007");
1513 } else {
1514 $self->old_bg_opts ($arg);
1515 my $expr = $self->old_bg_expr;
1516 $self->set_expr (parse_expr $expr) if $expr;
1517 }
1518 } elsif ($op eq "705") {
1519 $self->{bg_opts}->{tint} = $arg;
1520 my $expr = $self->old_bg_expr;
1521 $self->set_expr (parse_expr $expr) if $expr;
1522 }
1523
1524 1
1525}
1526
1527sub find_resource {
1528 my ($self, $a, $b) = @_;
1529
1530 my $v = $self->x_resource ($a);
1531 $v = $self->x_resource ($b) unless defined $v;
1532
1533 $v
1534}
1535
1032sub on_start { 1536sub on_start {
1033 my ($self) = @_; 1537 my ($self) = @_;
1034 1538
1035 my $expr = $self->x_resource ("%.expr") 1539 my $expr = $self->x_resource ("%.expr");
1540
1541 if (!$expr) {
1542 $self->{bg_opts} = { h_scale => 100, v_scale => 100,
1543 h_align => 50, v_align => 50 };
1544
1545 $self->{bg_opts}->{shade} = $self->find_resource ("shading", "sh");
1546 $self->{bg_opts}->{tint} = $self->find_resource ("tintColor", "tint");
1547 $self->{bg_opts}->{blur} = $self->find_resource ("blurRadius", "blr");
1548 if ($self->x_resource_boolean ("transparent")
1549 or $self->x_resource_boolean ("tr")) {
1550 $self->{bg_opts}->{root} = 1;
1551 }
1552
1553 $self->old_bg_opts ($self->find_resource ("backgroundPixmap", "pixmap"));
1554 $expr = $self->old_bg_expr;
1555 }
1556
1036 or return; 1557 $expr or return;
1037 1558
1038 $self->has_render 1559 $self->has_render
1039 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; 1560 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
1040 1561
1041 $self->set_expr (parse_expr $expr); 1562 $self->set_expr (parse_expr $expr);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines