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.81 by sf-exg, Wed Oct 24 11:20:28 2012 UTC vs.
Revision 1.86 by sf-exg, Fri Oct 4 17:09:57 2013 UTC

… …
279=cut 279=cut
280 280
281our %_IMG_CACHE; 281our %_IMG_CACHE;
282our $HOME; 282our $HOME;
283our ($self, $frame); 283our ($self, $frame);
284our ($x, $y, $w, $h); 284our ($x, $y, $w, $h, $focus);
285 285
286# enforce at least this interval between updates 286# enforce at least this interval between updates
287our $MIN_INTERVAL = 6/59.951; 287our $MIN_INTERVAL = 6/59.951;
288 288
289{ 289{
… …
308 308
309Loads the image at the given C<$path>. The image is set to plane tiling 309Loads the image at the given C<$path>. The image is set to plane tiling
310mode. 310mode.
311 311
312If the image is already in memory (e.g. because another terminal instance 312If the image is already in memory (e.g. because another terminal instance
313uses it), then the in-memory copy us returned instead. 313uses it), then the in-memory copy is returned instead.
314 314
315=item load_uc $path 315=item load_uc $path
316 316
317Load 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
318is I<always> loaded from the filesystem again, even if another copy of it 318is I<always> loaded from the filesystem again, even if another copy of it
… …
524 524
525Return the X and Y coordinates of the terminal window (the terminal 525Return the X and Y coordinates of the terminal window (the terminal
526window is the full window by default, and the character area only when in 526window is the full window by default, and the character area only when in
527border-respect mode). 527border-respect mode).
528 528
529Using these functions make your expression sensitive to window moves. 529Using these functions makes your expression sensitive to window moves.
530 530
531These functions are mainly useful to align images to the root window. 531These functions are mainly useful to align images to the root window.
532 532
533Example: load an image and align it so it looks as if anchored to the 533Example: load an image and align it so it looks as if anchored to the
534background (that's exactly what C<rootalign> does btw.): 534background (that's exactly what C<rootalign> does btw.):
… …
541 541
542Return 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
543terminal 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
544when in border-respect mode). 544when in border-respect mode).
545 545
546Using these functions make your expression sensitive to window resizes. 546Using these functions makes your expression sensitive to window resizes.
547 547
548These functions are mainly useful to scale images, or to clip images to 548These functions are mainly useful to scale images, or to clip images to
549the window size to conserve memory. 549the window size to conserve memory.
550 550
551Example: take the screen background, clip it to the window size, blur it a 551Example: take the screen background, clip it to the window size, blur it a
552bit, align it to the window position and use it as background. 552bit, align it to the window position and use it as background.
553 553
554 clip move -TX, -TY, keep { blur 5, root } 554 clip move -TX, -TY, keep { blur 5, root }
555 555
556=cut 556=item FOCUS
557 557
558Returns a boolean indicating whether the terminal window has keyboard
559focus, in which case it returns true.
560
561Using this function makes your expression sensitive to focus changes.
562
563A common use case is to fade the background image when the terminal loses
564focus, often together with the C<-fade> command line option. In fact,
565there is a special function for just that use case: C<focus_fade>.
566
567Example: use two entirely different background images, depending on
568whether the window has focus.
569
570 FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" }
571
572=cut
573
558 sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } 574 sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
559 sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } 575 sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
560 sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } 576 sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
561 sub TH() { $frame->[FR_AGAIN]{size} = 1; $h } 577 sub TH () { $frame->[FR_AGAIN]{size} = 1; $h }
578 sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus }
562 579
563=item now 580=item now
564 581
565Returns the current time as (fractional) seconds since the epoch. 582Returns the current time as (fractional) seconds since the epoch.
566 583
… …
817 834
818 sub tint($$) { 835 sub tint($$) {
819 $_[1]->tint ($_[0]) 836 $_[1]->tint ($_[0])
820 } 837 }
821 838
839=item shade $factor, $img
840
841Shade the image by the given factor.
842
843=cut
844
845 sub shade($$) {
846 $_[1]->shade ($_[0])
847 }
848
822=item contrast $factor, $img 849=item contrast $factor, $img
823 850
824=item contrast $r, $g, $b, $img 851=item contrast $r, $g, $b, $img
825 852
826=item contrast $r, $g, $b, $a, $img 853=item contrast $r, $g, $b, $a, $img
… …
920=cut 947=cut
921 948
922 sub blur($$;$) { 949 sub blur($$;$) {
923 my $img = pop; 950 my $img = pop;
924 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) 951 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
952 }
953
954=item focus_fade $img
955
956=item focus_fade $factor, $img
957
958=item focus_fade $factor, $color, $img
959
960Fades the image by the given factor (and colour) when focus is lost (the
961same as the C<-fade>/C<-fadecolor> command line options, which also supply
962the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
963C<$factor> is the real value, not a percentage value (that is, 0..1, not
9640..100).
965
966Example: do the right thing when focus fading is requested.
967
968 focus_fade load "mybg.jpg";
969
970=cut
971
972 sub focus_fade($;$$) {
973 my $img = pop;
974
975 return $img
976 if FOCUS;
977
978 my $fade = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0;
979 my $color = @_ >= 2 ? $_[1] : $self->resource ("color+" . urxvt::Color_fade);
980
981 $img = $img->tint ($color) if $color ne "rgb:00/00/00";
982 $img = $img->muladd (1 - $fade, 0) if $fade;
983
984 $img
925 } 985 }
926 986
927=back 987=back
928 988
929=head2 OTHER STUFF 989=head2 OTHER STUFF
… …
1068 if ($again->{rootpmap}) { 1128 if ($again->{rootpmap}) {
1069 $state->{rootpmap} = $self->on (rootpmap_change => $cb); 1129 $state->{rootpmap} = $self->on (rootpmap_change => $cb);
1070 } else { 1130 } else {
1071 delete $state->{rootpmap}; 1131 delete $state->{rootpmap};
1072 } 1132 }
1133
1134 if ($again->{focus}) {
1135 $state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
1136 } else {
1137 delete $state->{focus};
1138 }
1073} 1139}
1074 1140
1075# evaluate the current bg expression 1141# evaluate the current bg expression
1076sub recalculate { 1142sub recalculate {
1077 my ($arg_self) = @_; 1143 my ($arg_self) = @_;
… …
1092 local $self = $arg_self; 1158 local $self = $arg_self;
1093 local $HOME = $ENV{HOME}; 1159 local $HOME = $ENV{HOME};
1094 local $frame = $self->{root}; 1160 local $frame = $self->{root};
1095 1161
1096 ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); 1162 ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
1163 $focus = $self->focus;
1097 1164
1098 # evaluate user expression 1165 # evaluate user expression
1099 1166
1100 my @img = eval { $self->{expr}->() }; 1167 my @img = eval { $self->{expr}->() };
1101 die $@ if $@; 1168 die $@ if $@;

Diff Legend

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