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.69 by root, Mon Jul 2 01:32:26 2012 UTC vs.
Revision 1.78 by root, Tue Sep 4 11:24:24 2012 UTC

… …
11=head1 SYNOPSIS 11=head1 SYNOPSIS
12 12
13 urxvt --background-expr 'background expression' 13 urxvt --background-expr 'background expression'
14 --background-border 14 --background-border
15 --background-interval seconds 15 --background-interval seconds
16
17=head1 QUICK AND DIRTY CHEAT SHEET
18
19Just load a random jpeg image and tile the background with it without
20scaling or anything else:
21
22 load "/path/to/img.jpg"
23
24The same, but use mirroring/reflection instead of tiling:
25
26 mirror load "/path/to/img.jpg"
27
28Load an image and scale it to exactly fill the terminal window:
29
30 scale keep { load "/path/to/img.jpg" }
31
32Implement pseudo-transparency by using a suitably-aligned root pixmap
33as window background:
34
35 rootalign root
36
37Likewise, but keep a blurred copy:
38
39 rootalign keep { blur 10, root }
16 40
17=head1 DESCRIPTION 41=head1 DESCRIPTION
18 42
19This extension manages the terminal background by creating a picture that 43This extension manages the terminal background by creating a picture that
20is behind the text, replacing the normal background colour. 44is behind the text, replacing the normal background colour.
… …
74 return load "$HOME/sunday.png"; 98 return load "$HOME/sunday.png";
75 } 99 }
76 } 100 }
77 101
78This inner expression is evaluated once per hour (and whenever the 102This inner expression is evaluated once per hour (and whenever the
79temrinal window is resized). It sets F<sunday.png> as background on 103terminal window is resized). It sets F<sunday.png> as background on
80Sundays, and F<weekday.png> on all other days. 104Sundays, and F<weekday.png> on all other days.
81 105
82Fortunately, we expect that most expressions will be much simpler, with 106Fortunately, we expect that most expressions will be much simpler, with
83little Perl knowledge needed. 107little Perl knowledge needed.
84 108
… …
119width and doubles the image height: 143width and doubles the image height:
120 144
121 scale 0.5, 2, load "$HOME/mypic.png" 145 scale 0.5, 2, load "$HOME/mypic.png"
122 146
123IF you try out these expressions, you might suffer from some sluggishness, 147IF you try out these expressions, you might suffer from some sluggishness,
124because each time the terminal is resized, it loads the PNG image agin 148because each time the terminal is resized, it loads the PNG image again
125and scales it. Scaling is usually fast (and unavoidable), but loading the 149and scales it. Scaling is usually fast (and unavoidable), but loading the
126image can be quite time consuming. This is where C<keep> comes in handy: 150image can be quite time consuming. This is where C<keep> comes in handy:
127 151
128 scale 0.5, 2, keep { load "$HOME/mypic.png" } 152 scale 0.5, 2, keep { load "$HOME/mypic.png" }
129 153
… …
156 180
157This one first takes a snapshot of the screen background image, and then 181This one first takes a snapshot of the screen background image, and then
158moves it to the upper left corner of the screen (as opposed to the upper 182moves it to the upper left corner of the screen (as opposed to the upper
159left corner of the terminal window)- the result is pseudo-transparency: 183left corner of the terminal window)- the result is pseudo-transparency:
160the image seems to be static while the window is moved around. 184the image seems to be static while the window is moved around.
185
186=head2 COLOUR SPECIFICATIONS
187
188Whenever an operator expects a "colour", then this can be specified in one
189of two ways: Either as string with an X11 colour specification, such as:
190
191 "red" # named colour
192 "#f00" # simple rgb
193 "[50]red" # red with 50% alpha
194 "TekHVC:300/50/50" # anything goes
195
196OR as an array reference with one, three or four components:
197
198 [0.5] # 50% gray, 100% alpha
199 [0.5, 0, 0] # dark red, no green or blur, 100% alpha
200 [0.5, 0, 0, 0.7] # same with explicit 70% alpha
161 201
162=head2 CACHING AND SENSITIVITY 202=head2 CACHING AND SENSITIVITY
163 203
164Since some operations (such as C<load> and C<blur>) can take a long time, 204Since some operations (such as C<load> and C<blur>) can take a long time,
165caching results can be very important for a smooth operation. Caching can 205caching results can be very important for a smooth operation. Caching can
… …
273uses it), then the in-memory copy us returned instead. 313uses it), then the in-memory copy us returned instead.
274 314
275=item load_uc $path 315=item load_uc $path
276 316
277Load uncached - same as load, but does not cache the image, which means it 317Load uncached - same as load, but does not cache the image, which means it
278is I<always> loaded from the filesystem again. 318is I<always> loaded from the filesystem again, even if another copy of it
319is in memory at the time.
279 320
280=cut 321=cut
322
323 sub load_uc($) {
324 $self->new_img_from_file ($_[0])
325 }
281 326
282 sub load($) { 327 sub load($) {
283 my ($path) = @_; 328 my ($path) = @_;
284 329
285 $_IMG_CACHE{$path} || do { 330 $_IMG_CACHE{$path} || do {
286 my $img = $self->new_img_from_file ($path); 331 my $img = load_uc $path;
287 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); 332 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
288 $img 333 $img
289 } 334 }
290 } 335 }
291 336
… …
376 $base->draw ($_) 421 $base->draw ($_)
377 for @_; 422 for @_;
378 423
379 $base 424 $base
380 } 425 }
426
427=back
381 428
382=head2 TILING MODES 429=head2 TILING MODES
383 430
384The following operators modify the tiling mode of an image, that is, the 431The following operators modify the tiling mode of an image, that is, the
385way that pixels outside the image area are painted when the image is used. 432way that pixels outside the image area are painted when the image is used.
… …
488 535
489 move -TX, -TY, keep { load "mybg.png" } 536 move -TX, -TY, keep { load "mybg.png" }
490 537
491=item TW 538=item TW
492 539
540=item TH
541
493Return the width (C<TW>) and height (C<TH>) of the terminal window (the 542Return the width (C<TW>) and height (C<TH>) of the terminal window (the
494terminal window is the full window by default, and the character area only 543terminal window is the full window by default, and the character area only
495when in border-respect mode). 544when in border-respect mode).
496 545
497Using these functions make your expression sensitive to window resizes. 546Using these functions make your expression sensitive to window resizes.
… …
564Clips an image to the given rectangle. If the rectangle is outside the 613Clips an image to the given rectangle. If the rectangle is outside the
565image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is 614image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
566larger than the image, then the tiling mode defines how the extra pixels 615larger than the image, then the tiling mode defines how the extra pixels
567will be filled. 616will be filled.
568 617
569If C<$x> an C<$y> are missing, then C<0> is assumed for both. 618If C<$x> and C<$y> are missing, then C<0> is assumed for both.
570 619
571If C<$width> and C<$height> are missing, then the window size will be 620If C<$width> and C<$height> are missing, then the window size will be
572assumed. 621assumed.
573 622
574Example: load an image, blur it, and clip it to the window size to save 623Example: load an image, blur it, and clip it to the window size to save
… …
750 799
751The following operators change the pixels of the image. 800The following operators change the pixels of the image.
752 801
753=over 4 802=over 4
754 803
804=item tint $color, $img
805
806Tints the image in the given colour.
807
808Example: tint the image red.
809
810 tint "red", load "rgb.png"
811
812Example: the same, but specify the colour by component.
813
814 tint [1, 0, 0], load "rgb.png"
815
816=cut
817
818 sub tint($$) {
819 $_[1]->tint ($_[0])
820 }
821
755=item contrast $factor, $img 822=item contrast $factor, $img
756 823
757=item contrast $r, $g, $b, $img 824=item contrast $r, $g, $b, $img
758 825
759=item contrast $r, $g, $b, $a, $img 826=item contrast $r, $g, $b, $a, $img
… …
788latter in a white picture. 855latter in a white picture.
789 856
790Due to idiosyncrasies in the underlying XRender extension, biases less 857Due to idiosyncrasies in the underlying XRender extension, biases less
791than zero can be I<very> slow. 858than zero can be I<very> slow.
792 859
860You can also try the experimental(!) C<muladd> operator.
861
793=cut 862=cut
794 863
795 sub contrast($$;$$;$) { 864 sub contrast($$;$$;$) {
796 my $img = pop; 865 my $img = pop;
797 my ($r, $g, $b, $a) = @_; 866 my ($r, $g, $b, $a) = @_;
… …
812 $a = 1 if @_ < 4; 881 $a = 1 if @_ < 4;
813 882
814 $img = $img->clone; 883 $img = $img->clone;
815 $img->brightness ($r, $g, $b, $a); 884 $img->brightness ($r, $g, $b, $a);
816 $img 885 $img
886 }
887
888=item muladd $mul, $add, $img # EXPERIMENTAL
889
890First multipliesthe pixels by C<$mul>, then adds C<$add>. This cna be used
891to implement brightness and contrast at the same time, with a wider value
892range than contrast and brightness operators.
893
894Due to numerous bugs in XRender implementations, it can also introduce a
895number of visual artifacts.
896
897Example: increase contrast by a factor of C<$c> without changing image
898brightness too much.
899
900 muladd $c, (1 - $c) * 0.5, $img
901
902=cut
903
904 sub muladd($$$) {
905 $_[2]->muladd ($_[0], $_[1])
817 } 906 }
818 907
819=item blur $radius, $img 908=item blur $radius, $img
820 909
821=item blur $radius_horz, $radius_vert, $img 910=item blur $radius_horz, $radius_vert, $img
… …
866C<keep> block so it only is reevaluated as required. 955C<keep> block so it only is reevaluated as required.
867 956
868Putting the blur into a C<keep> block will make sure the blur is only done 957Putting the blur into a C<keep> block will make sure the blur is only done
869once, while the C<rootalign> is still done each time the window moves. 958once, while the C<rootalign> is still done each time the window moves.
870 959
871 rootlign keep { blur 10, root } 960 rootalign keep { blur 10, root }
872 961
873This leaves the question of how to force reevaluation of the block, 962This leaves the question of how to force reevaluation of the block,
874in case the root background changes: If expression inside the block 963in case the root background changes: If expression inside the block
875is sensitive to some event (root background changes, window geometry 964is sensitive to some event (root background changes, window geometry
876changes), then it will be reevaluated automatically as needed. 965changes), then it will be reevaluated automatically as needed.
… …
928 1017
929# compiles a parsed expression 1018# compiles a parsed expression
930sub set_expr { 1019sub set_expr {
931 my ($self, $expr) = @_; 1020 my ($self, $expr) = @_;
932 1021
933 $self->{root} = []; 1022 $self->{root} = []; # the outermost frame
934 $self->{expr} = $expr; 1023 $self->{expr} = $expr;
935 $self->recalculate; 1024 $self->recalculate;
936} 1025}
937 1026
938# takes a hash of sensitivity indicators and installs watchers 1027# takes a hash of sensitivity indicators and installs watchers
… …
1000 1089
1001 # set environment to evaluate user expression 1090 # set environment to evaluate user expression
1002 1091
1003 local $self = $arg_self; 1092 local $self = $arg_self;
1004 local $HOME = $ENV{HOME}; 1093 local $HOME = $ENV{HOME};
1005 local $frame = []; 1094 local $frame = $self->{root};
1006 1095
1007 ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); 1096 ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
1008 1097
1009 # evaluate user expression 1098 # evaluate user expression
1010 1099

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines