--- rxvt-unicode/src/perl/background 2012/06/10 11:31:22 1.44 +++ rxvt-unicode/src/perl/background 2012/06/10 13:32:55 1.46 @@ -1,7 +1,8 @@ #! perl #:META:X_RESOURCE:%.expr:string:background expression -#:META:X_RESOURCE:%.border.:boolean:respect the terminal border +#:META:X_RESOURCE:%.border:boolean:respect the terminal border +#:META:X_RESOURCE:%.interval:seconds:minimum time between updates #TODO: once, rootalign @@ -13,6 +14,7 @@ urxvt --background-expr 'background expression' --background-border + --background-interval seconds =head1 DESCRIPTION @@ -191,6 +193,15 @@ Specifying this flag changes the behaviour, so that the image only replaces the background of the character area. +=item --background-interval seconds + +Since some operations in the underlying XRender extension can effetively +freeze your X-server for prolonged time, this extension enforces a minimum +time between updates, which is normally about 0.1 seconds. + +If you want to do updates more often, you can decrease this safety +interval with this switch. + =back =cut @@ -200,7 +211,7 @@ our ($x, $y, $w, $h); # enforce at least this interval between updates -our $MIN_INTERVAL = 1/100; +our $MIN_INTERVAL = 6/59.951; { package urxvt::bgdsl; # background language @@ -265,91 +276,15 @@ $img } -=back - -=head2 VARIABLES - -The following functions provide variable data such as the terminal window -dimensions. They are not (Perl-) variables, they jsut return stuff that -varies. Most of them make your expression sensitive to some events, for -example using C (terminal width) means your expression is evaluated -again when the terminal is resized. - -=over 4 - -=item TX - -=item TY - -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. - -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. - - move -TX, -TY, load "mybg.png" - -=item TW - -Return the width (C) and height (C) 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. - -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, blur 5, root - -=cut - - sub TX() { $new->{position_sensitive} = 1; $x } - sub TY() { $new->{position_sensitive} = 1; $y } - sub TW() { $new->{size_sensitive} = 1; $w } - sub TH() { $new->{size_sensitive} = 1; $h } - -=item now - -Returns the current time as (fractional) seconds since the epoch. - -Using this expression does I make your expression sensitive to time, -but the next two functions do. - -=item again $seconds - -When this function is used the expression will be reevaluated again in -C<$seconds> seconds. - -Example: load some image and rotate it according to the time of day (as if it were -the hour pointer of a clock). Update this image every minute. - - again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" - -=item counter $seconds +=item clone $img -Like C, but also returns an increasing counter value, starting at -0, which might be useful for some simple animation effects. +Returns an exact copy of the image. This is useful if you want to have +multiple copies of the same image to apply different effects to. =cut - sub now() { urxvt::NOW } - - sub again($) { - $new->{again} = $_[0]; - } - - sub counter($) { - $new->{again} = $_[0]; - $self->{counter} + 0 + sub clone($) { + $_[0]->clone } =back @@ -436,22 +371,99 @@ =back -=head2 PIXEL OPERATORS +=head2 VARIABLE VALUES -The following operators modify the image pixels in various ways. +The following functions provide variable data such as the terminal window +dimensions. They are not (Perl-) variables, they just return stuff that +varies. Most of them make your expression sensitive to some events, for +example using C (terminal width) means your expression is evaluated +again when the terminal is resized. =over 4 -=item clone $img +=item TX -Returns an exact copy of the image. +=item TY + +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. + +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. + + move -TX, -TY, load "mybg.png" + +=item TW + +Return the width (C) and height (C) 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. + +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, blur 5, root =cut - sub clone($) { - $_[0]->clone + sub TX() { $new->{position_sensitive} = 1; $x } + sub TY() { $new->{position_sensitive} = 1; $y } + sub TW() { $new->{size_sensitive} = 1; $w } + sub TH() { $new->{size_sensitive} = 1; $h } + +=item now + +Returns the current time as (fractional) seconds since the epoch. + +Using this expression does I make your expression sensitive to time, +but the next two functions do. + +=item again $seconds + +When this function is used the expression will be reevaluated again in +C<$seconds> seconds. + +Example: load some image and rotate it according to the time of day (as if it were +the hour pointer of a clock). Update this image every minute. + + again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" + +=item counter $seconds + +Like C, but also returns an increasing counter value, starting at +0, which might be useful for some simple animation effects. + +=cut + + sub now() { urxvt::NOW } + + sub again($) { + $new->{again} = $_[0]; } + sub counter($) { + $new->{again} = $_[0]; + $self->{counter} + 0 + } + +=back + +=head2 SHAPE CHANGING OPERATORS + +The following operators modify the shape, size or position of the image. + +=over 4 + =item clip $img =item clip $width, $height, $img @@ -554,6 +566,17 @@ move 20, 30, ... +=item align $xalign, $yalign, $img + +Aligns the image according to a factor - C<0> means the image is moved to +the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is +exactly centered and C<1> means it touches the right or bottom edge. + +Example: remove any visible border around an image, center it vertically but move +it to the right hand side. + + align 1, 0.5, pad $img + =item center $img =item center $width, $height, $img @@ -562,6 +585,10 @@ the terminal window (or the box specified by C<$width> and C<$height> if given). +Example: load an image and center it. + + center pad load "mybg.png" + =item rootalign $img Moves the image so that it appears glued to the screen as opposed to the @@ -576,7 +603,7 @@ Example: take the screen background and align it, giving the illusion of transparency as long as the window isn't in front of other windows. - rootalign root + rootalign root =cut @@ -586,10 +613,18 @@ $img } + sub align($;$$) { + my $img = pop; + + move $_[0] * (TW - $img->w), + $_[1] * (TH - $img->h), + $img + } + sub center($;$$) { my $img = pop; my $w = $_[0] || TW; - my $h = $_[0] || TH; + my $h = $_[1] || TH; move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img } @@ -598,6 +633,14 @@ move -TX, -TY, $_[0] } +=back + +=head2 COLOUR MODIFICATIONS + +The following operators change the pixels of the image. + +=over 4 + =item contrast $factor, $img =item contrast $r, $g, $b, $img @@ -606,9 +649,18 @@ Adjusts the I of an image. -#TODO# +The first form applies a single C<$factor> to red, green and blue, the +second form applies separate factors to each colour channel, and the last +form includes the alpha channel. + +Values from 0 to 1 lower the contrast, values higher than 1 increase the +contrast. + +Due to limitations in the underlying XRender extension, lowering contrast +also reduces brightness, while increasing contrast currently also +increases brightness. -=item brightness $factor, $img +=item brightness $bias, $img =item brightness $r, $g, $b, $img @@ -616,6 +668,17 @@ Adjusts the brightness of an image. +The first form applies a single C<$bias> to red, green and blue, the +second form applies separate biases to each colour channel, and the last +form includes the alpha channel. + +Values less than 0 reduce brightness, while values larger than 0 increase +it. Useful range is from -1 to 1 - the former results in a black, the +latter in a white picture. + +Due to idiosynchrasies in the underlying XRender extension, biases less +than zero can be I slow. + =cut sub contrast($$;$$;$) { @@ -801,6 +864,8 @@ $self->set_expr (parse_expr $expr); $self->{border} = $self->x_resource_boolean ("background.border"); + $MIN_INTERVAL = $self->x_resource ("background.interval"); + () }