[ViewVC] Diff of: cvs/rxvt-unicode/src/perl/background

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.77 by root, Tue Sep 4 11:21:11 2012 UTC vs.
Revision 1.87 by sf-exg, Sat Oct 12 08:36:44 2013 UTC

 #:META:X_RESOURCE:%.border:boolean:respect the terminal border
 #:META:X_RESOURCE:%.interval:seconds:minimum time between updates
 =head1 NAME
-   background - manage terminal background
+background - manage terminal background
 =head1 SYNOPSIS
    urxvt --background-expr 'background expression'
          --background-border
 =cut
 our %_IMG_CACHE;
 our $HOME;
 our ($self, $frame);
-our ($x, $y, $w, $h);
+our ($x, $y, $w, $h, $focus);
 # enforce at least this interval between updates
 our $MIN_INTERVAL = 6/59.951;
 {
 Loads the image at the given C<$path>. The image is set to plane tiling
 mode.
 If the image is already in memory (e.g. because another terminal instance
-uses it), then the in-memory copy us returned instead.
+uses it), then the in-memory copy is returned instead.
 =item load_uc $path
 Load uncached - same as load, but does not cache the image, which means it
 is I<always> loaded from the filesystem again, even if another copy of it
 Return the X and Y coordinates of the terminal window (the terminal
 window is the full window by default, and the character area only when in
 border-respect mode).
-Using these functions make your expression sensitive to window moves.
+Using these functions makes your expression sensitive to window moves.
 These functions are mainly useful to align images to the root window.
 Example: load an image and align it so it looks as if anchored to the
 background (that's exactly what C<rootalign> does btw.):
 Return the width (C<TW>) and height (C<TH>) of the terminal window (the
 terminal window is the full window by default, and the character area only
 when in border-respect mode).
-Using these functions make your expression sensitive to window resizes.
+Using these functions makes your expression sensitive to window resizes.
 These functions are mainly useful to scale images, or to clip images to
 the window size to conserve memory.
 Example: take the screen background, clip it to the window size, blur it a
 bit, align it to the window position and use it as background.
    clip move -TX, -TY, keep { blur 5, root }
-=cut
+=item FOCUS
+Returns a boolean indicating whether the terminal window has keyboard
+focus, in which case it returns true.
+Using this function makes your expression sensitive to focus changes.
+A common use case is to fade the background image when the terminal loses
+focus, often together with the C<-fade> command line option. In fact,
+there is a special function for just that use case: C<focus_fade>.
+Example: use two entirely different background images, depending on
+whether the window has focus.
+   FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" }
+=cut
-   sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
+   sub TX   () { $frame->[FR_AGAIN]{position} = 1; $x     }
-   sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
+   sub TY   () { $frame->[FR_AGAIN]{position} = 1; $y     }
-   sub TW() { $frame->[FR_AGAIN]{size}     = 1; $w }
+   sub TW   () { $frame->[FR_AGAIN]{size}     = 1; $w     }
-   sub TH() { $frame->[FR_AGAIN]{size}     = 1; $h }
+   sub TH   () { $frame->[FR_AGAIN]{size}     = 1; $h     }
+   sub FOCUS() { $frame->[FR_AGAIN]{focus}    = 1; $focus }
 =item now
 Returns the current time as (fractional) seconds since the epoch.
 Clips an image to the given rectangle. If the rectangle is outside the
 image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
 larger than the image, then the tiling mode defines how the extra pixels
 will be filled.
-If C<$x> an C<$y> are missing, then C<0> is assumed for both.
+If C<$x> and C<$y> are missing, then C<0> is assumed for both.
 If C<$width> and C<$height> are missing, then the window size will be
 assumed.
 Example: load an image, blur it, and clip it to the window size to save
 =item scale $width_factor, $height_factor, $img
 Scales the image by the given factors in horizontal
 (C<$width>) and vertical (C<$height>) direction.
-If only one factor is give, it is used for both directions.
+If only one factor is given, it is used for both directions.
 If no factors are given, scales the image to the window size without
 keeping aspect.
 =item resize $width, $height, $img
 =item rotate $center_x, $center_y, $degrees, $img
 Rotates the image clockwise by C<$degrees> degrees, around the point at
 C<$center_x> and C<$center_y> (specified as factor of image width/height).
-Example: rotate the image by 90 degrees around it's center.
+Example: rotate the image by 90 degrees around its center.
    rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
 =cut
    sub tint($$) {
       $_[1]->tint ($_[0])
    }
+=item shade $factor, $img
+Shade the image by the given factor.
+=cut
+   sub shade($$) {
+      $_[1]->shade ($_[0])
+   }
 =item contrast $factor, $img
 =item contrast $r, $g, $b, $img
 =item contrast $r, $g, $b, $a, $img
       $img
    }
 =item muladd $mul, $add, $img # EXPERIMENTAL
-First multipliesthe pixels by C<$mul>, then adds C<$add>. This cna be used
+First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used
 to implement brightness and contrast at the same time, with a wider value
 range than contrast and brightness operators.
 Due to numerous bugs in XRender implementations, it can also introduce a
 number of visual artifacts.
 =cut
    sub blur($$;$) {
       my $img = pop;
       $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
+   }
+=item focus_fade $img
+=item focus_fade $factor, $img
+=item focus_fade $factor, $color, $img
+Fades the image by the given factor (and colour) when focus is lost (the
+same as the C<-fade>/C<-fadecolor> command line options, which also supply
+the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
+C<$factor> is a real value, not a percentage value (that is, 0..1, not
+0..100).
+Example: do the right thing when focus fading is requested.
+   focus_fade load "mybg.jpg";
+=cut
+   sub focus_fade($;$$) {
+      my $img = pop;
+      return $img
+         if FOCUS;
+      my $fade   = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0;
+      my $color  = @_ >= 2 ? $_[1] : $self->resource ("color+" . urxvt::Color_fade);
+      $img = $img->tint ($color)         if $color ne "rgb:00/00/00";
+      $img = $img->muladd (1 - $fade, 0) if $fade;
+      $img
    }
 =back
 =head2 OTHER STUFF
    if ($again->{rootpmap}) {
       $state->{rootpmap} = $self->on (rootpmap_change => $cb);
    } else {
       delete $state->{rootpmap};
    }
+   if ($again->{focus}) {
+      $state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
+   } else {
+      delete $state->{focus};
+   }
 }
 # evaluate the current bg expression
 sub recalculate {
    my ($arg_self) = @_;
    local $self  = $arg_self;
    local $HOME  = $ENV{HOME};
    local $frame = $self->{root};
    ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
+   $focus           = $self->focus;
    # evaluate user expression
    my @img = eval { $self->{expr}->() };
    die $@ if $@;

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.77 by root, Tue Sep 4 11:21:11 2012 UTC vs. Revision 1.87 by sf-exg, Sat Oct 12 08:36:44 2013 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.77 by root, Tue Sep 4 11:21:11 2012 UTC vs.
Revision 1.87 by sf-exg, Sat Oct 12 08:36:44 2013 UTC