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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.68 by root, Sun Jul 1 21:47:07 2012 UTC vs.
Revision 1.85 by root, Thu Oct 3 01:11:48 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
          --background-interval seconds
+=head1 QUICK AND DIRTY CHEAT SHEET
+Just load a random jpeg image and tile the background with it without
+scaling or anything else:
+   load "/path/to/img.jpg"
+The same, but use mirroring/reflection instead of tiling:
+   mirror load "/path/to/img.jpg"
+Load an image and scale it to exactly fill the terminal window:
+   scale keep { load "/path/to/img.jpg" }
+Implement pseudo-transparency by using a suitably-aligned root pixmap
+as window background:
+   rootalign root
+Likewise, but keep a blurred copy:
+   rootalign keep { blur 10, root }
 =head1 DESCRIPTION
 This extension manages the terminal background by creating a picture that
 is behind the text, replacing the normal background colour.
          return load "$HOME/sunday.png";
       }
    }
 This inner expression is evaluated once per hour (and whenever the
-temrinal window is resized). It sets F<sunday.png> as background on
+terminal window is resized). It sets F<sunday.png> as background on
 Sundays, and F<weekday.png> on all other days.
 Fortunately, we expect that most expressions will be much simpler, with
 little Perl knowledge needed.
 width and doubles the image height:
    scale 0.5, 2, load "$HOME/mypic.png"
 IF you try out these expressions, you might suffer from some sluggishness,
-because each time the terminal is resized, it loads the PNG image agin
+because each time the terminal is resized, it loads the PNG image again
 and scales it. Scaling is usually fast (and unavoidable), but loading the
 image can be quite time consuming. This is where C<keep> comes in handy:
    scale 0.5, 2, keep { load "$HOME/mypic.png" }
 This one first takes a snapshot of the screen background image, and then
 moves it to the upper left corner of the screen (as opposed to the upper
 left corner of the terminal window)- the result is pseudo-transparency:
 the image seems to be static while the window is moved around.
+=head2 COLOUR SPECIFICATIONS
+Whenever an operator expects a "colour", then this can be specified in one
+of two ways: Either as string with an X11 colour specification, such as:
+   "red"               # named colour
+   "#f00"              # simple rgb
+   "[50]red"           # red with 50% alpha
+   "TekHVC:300/50/50"  # anything goes
+OR as an array reference with one, three or four components:
+   [0.5]               # 50% gray, 100% alpha
+   [0.5, 0, 0]         # dark red, no green or blur, 100% alpha
+   [0.5, 0, 0, 0.7]    # same with explicit 70% alpha
 =head2 CACHING AND SENSITIVITY
 Since some operations (such as C<load> and C<blur>) can take a long time,
 caching results can be very important for a smooth operation. Caching can
 =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.
+is I<always> loaded from the filesystem again, even if another copy of it
+is in memory at the time.
 =cut
    sub load_uc($) {
-      $self->new_img_from_file ($path)
+      $self->new_img_from_file ($_[0])
    }
    sub load($) {
       my ($path) = @_;
          for @_;
       $base
    }
+=back
 =head2 TILING MODES
 The following operators modify the tiling mode of an image, that is, the
 way that pixels outside the image area are painted when the image is used.
 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.):
    move -TX, -TY, keep { load "mybg.png" }
 =item TW
+=item TH
 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 bacckground 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
 The following operators change the pixels of the image.
 =over 4
+=item tint $color, $img
+Tints the image in the given colour.
+Example: tint the image red.
+   tint "red", load "rgb.png"
+Example: the same, but specify the colour by component.
+   tint [1, 0, 0], load "rgb.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
 latter in a white picture.
 Due to idiosyncrasies in the underlying XRender extension, biases less
 than zero can be I<very> slow.
+You can also try the experimental(!) C<muladd> operator.
 =cut
    sub contrast($$;$$;$) {
       my $img = pop;
       my ($r, $g, $b, $a) = @_;
       $a       = 1        if @_ < 4;
       $img = $img->clone;
       $img->brightness ($r, $g, $b, $a);
       $img
+   }
+=item muladd $mul, $add, $img # EXPERIMENTAL
+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.
+Example: increase contrast by a factor of C<$c> without changing image
+brightness too much.
+   muladd $c, (1 - $c) * 0.5, $img
+=cut
+   sub muladd($$$) {
+      $_[2]->muladd ($_[0], $_[1])
    }
 =item blur $radius, $img
 =item blur $radius_horz, $radius_vert, $img
 =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 the 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
 C<keep> block so it only is reevaluated as required.
 Putting the blur into a C<keep> block will make sure the blur is only done
 once, while the C<rootalign> is still done each time the window moves.
-   rootlign keep { blur 10, root }
+   rootalign keep { blur 10, root }
 This leaves the question of how to force reevaluation of the block,
 in case the root background changes: If expression inside the block
 is sensitive to some event (root background changes, window geometry
 changes), then it will be reevaluated automatically as needed.
 # compiles a parsed expression
 sub set_expr {
    my ($self, $expr) = @_;
-   $self->{root} = [];
+   $self->{root} = []; # the outermost frame
    $self->{expr} = $expr;
    $self->recalculate;
 }
 # takes a hash of sensitivity indicators and installs watchers
    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) = @_;
    # set environment to evaluate user expression
    local $self  = $arg_self;
    local $HOME  = $ENV{HOME};
-   local $frame = [];
+   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.68 by root, Sun Jul 1 21:47:07 2012 UTC vs. Revision 1.85 by root, Thu Oct 3 01:11:48 2013 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.68 by root, Sun Jul 1 21:47:07 2012 UTC vs.
Revision 1.85 by root, Thu Oct 3 01:11:48 2013 UTC