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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.42 by root, Sun Jun 10 10:42:19 2012 UTC vs.
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC

…		…
1	#! perl	1	#! perl
2		2
3	#:META:X_RESOURCE:%.expr:string:background expression	3	#:META:X_RESOURCE:%.expr:string:background expression
4	#:META:X_RESOURCE:%.border.:boolean:respect the terminal border	4	#:META:X_RESOURCE:%.border:boolean:respect the terminal border
5		5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
6	#TODO: once, rootalign
7		6
8	=head1 NAME	7	=head1 NAME
9		8
10	background - manage terminal background	9	background - manage terminal background
11		10
12	=head1 SYNOPSIS	11	=head1 SYNOPSIS
13		12
14	urxvt --background-expr 'background expression'	13	urxvt --background-expr 'background expression'
15	--background-border	14	--background-border
		15	--background-interval seconds
16		16
17	=head1 DESCRIPTION	17	=head1 DESCRIPTION
18		18
19	This extension manages the terminal background by creating a picture that	19	This extension manages the terminal background by creating a picture that
20	is behind the text, replacing the normal background colour.	20	is behind the text, replacing the normal background colour.
57		57
58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the	58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the
59	image to the window size, so it relies on the window size and will	59	image to the window size, so it relies on the window size and will
60	be reevaluated each time it is changed, but not when it moves for	60	be reevaluated each time it is changed, but not when it moves for
61	example. That ensures that the picture always fills the terminal, even	61	example. That ensures that the picture always fills the terminal, even
62	after it's size changes.	62	after its size changes.
63		63
64	=head2 EXPRESSIONS	64	=head2 EXPRESSIONS
65		65
66	Expressions are normal Perl expressions, in fact, they are Perl blocks -	66	Expressions are normal Perl expressions, in fact, they are Perl blocks -
67	which means you could use multiple lines and statements:	67	which means you could use multiple lines and statements:
…		…
71	return scale load "$HOME/weekday.png";	71	return scale load "$HOME/weekday.png";
72	} else {	72	} else {
73	return scale load "$HOME/sunday.png";	73	return scale load "$HOME/sunday.png";
74	}	74	}
75		75
76	This expression gets evaluated once per hour. It will set F<sunday.png> as	76	This expression is evaluated once per hour. It will set F<sunday.png> as
77	background on Sundays, and F<weekday.png> on all other days.	77	background on Sundays, and F<weekday.png> on all other days.
78		78
79	Fortunately, we expect that most expressions will be much simpler, with	79	Fortunately, we expect that most expressions will be much simpler, with
80	little Perl knowledge needed.	80	little Perl knowledge needed.
81		81
…		…
99	its result becomes the argument to the C<scale> function.	99	its result becomes the argument to the C<scale> function.
100		100
101	Many operators also allow some parameters preceding the input image	101	Many operators also allow some parameters preceding the input image
102	that modify its behaviour. For example, C<scale> without any additional	102	that modify its behaviour. For example, C<scale> without any additional
103	arguments scales the image to size of the terminal window. If you specify	103	arguments scales the image to size of the terminal window. If you specify
104	an additional argument, it uses it as a percentage:	104	an additional argument, it uses it as a scale factor (multiply by 100 to
		105	get a percentage):
105		106
106	scale 200, load "$HOME/mypic.png"	107	scale 2, load "$HOME/mypic.png"
107		108
108	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>	109	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
109	has now two arguments, the C<200> and the C<load> expression, while	110	has now two arguments, the C<200> and the C<load> expression, while
110	C<load> only has one argument. Arguments are separated from each other by	111	C<load> only has one argument. Arguments are separated from each other by
111	commas.	112	commas.
112		113
113	Scale also accepts two arguments, which are then separate factors for both	114	Scale also accepts two arguments, which are then separate factors for both
114	horizontal and vertical dimensions. For example, this halves the image	115	horizontal and vertical dimensions. For example, this halves the image
115	width and doubles the image height:	116	width and doubles the image height:
116		117
117	scale 50, 200, load "$HOME/mypic.png"	118	scale 0.5, 2, load "$HOME/mypic.png"
118		119
119	Other effects than scalign are also readily available, for exmaple, you can	120	Other effects than scaling are also readily available, for example, you can
120	tile the image to fill the whole window, instead of resizing it:	121	tile the image to fill the whole window, instead of resizing it:
121		122
122	tile load "$HOME/mypic.png"	123	tile load "$HOME/mypic.png"
123		124
124	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator	125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
…		…
150	This only works for one cycle though, so as long as you load the same	151	This only works for one cycle though, so as long as you load the same
151	image every time, it will always be cached, but when you load a different	152	image every time, it will always be cached, but when you load a different
152	image, it will forget about the first one.	153	image, it will forget about the first one.
153		154
154	This allows you to either speed things up by keeping multiple images in	155	This allows you to either speed things up by keeping multiple images in
155	memory, or comserve memory by loading images more often.	156	memory, or conserve memory by loading images more often.
156		157
157	For example, you can keep two images in memory and use a random one like	158	For example, you can keep two images in memory and use a random one like
158	this:	159	this:
159		160
160	my $img1 = load "img1.png";	161	my $img1 = load "img1.png";
…		…
188	overwriting borders and any other areas, such as the scrollbar.	189	overwriting borders and any other areas, such as the scrollbar.
189		190
190	Specifying this flag changes the behaviour, so that the image only	191	Specifying this flag changes the behaviour, so that the image only
191	replaces the background of the character area.	192	replaces the background of the character area.
192		193
		194	=item --background-interval seconds
		195
		196	Since some operations in the underlying XRender extension can effectively
		197	freeze your X-server for prolonged time, this extension enforces a minimum
		198	time between updates, which is normally about 0.1 seconds.
		199
		200	If you want to do updates more often, you can decrease this safety
		201	interval with this switch.
		202
193	=back	203	=back
194		204
195	=cut	205	=cut
196		206
		207	our %_IMG_CACHE;
197	our $HOME;	208	our $HOME;
198	our ($self, $old, $new);	209	our ($self, $old, $new);
199	our ($x, $y, $w, $h);	210	our ($x, $y, $w, $h);
200		211
201	# enforce at least this interval between updates	212	# enforce at least this interval between updates
202	our $MIN_INTERVAL = 1/100;	213	our $MIN_INTERVAL = 6/59.951;
203		214
204	{	215	{
205	package urxvt::bgdsl; # background language	216	package urxvt::bgdsl; # background language
		217
		218	use List::Util qw(min max sum shuffle);
206		219
207	=head2 PROVIDERS/GENERATORS	220	=head2 PROVIDERS/GENERATORS
208		221
209	These functions provide an image, by loading it from disk, grabbing it	222	These functions provide an image, by loading it from disk, grabbing it
210	from the root screen or by simply generating it. They are used as starting	223	from the root screen or by simply generating it. They are used as starting
…		…
215	=item load $path	228	=item load $path
216		229
217	Loads the image at the given C<$path>. The image is set to plane tiling	230	Loads the image at the given C<$path>. The image is set to plane tiling
218	mode.	231	mode.
219		232
220	Loaded images will be cached for one cycle.	233	Loaded images will be cached for one cycle, and shared between temrinals
		234	running in the same process (e.g. in C<urxvtd>).
221		235
		236	=item load_uc $path
		237
		238	Load uncached - same as load, but does not cache the image. This function
		239	is most useufl if you want to optimise a background expression in some
		240	way.
		241
222	=cut	242	=cut
		243
		244	sub load_uc($) {
		245	my ($path) = @_;
		246
		247	$_IMG_CACHE{$path} \|\| do {
		248	my $img = $self->new_img_from_file ($path);
		249	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		250	$img
		251	}
		252	}
223		253
224	sub load($) {	254	sub load($) {
225	my ($path) = @_;	255	my ($path) = @_;
226		256
227	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
228	}	258	}
229		259
230	=item root	260	=item root
231		261
232	Returns the root window pixmap, that is, hopefully, the background image	262	Returns the root window pixmap, that is, hopefully, the background image
233	of your screen. The image is set to extend mode.	263	of your screen.
234		264
235	This function makes your expression root sensitive, that means it will be	265	This function makes your expression root sensitive, that means it will be
236	reevaluated when the bg image changes.	266	reevaluated when the bg image changes.
237		267
238	=cut	268	=cut
239		269
240	sub root() {	270	sub root() {
241	$new->{rootpmap_sensitive} = 1;	271	$new->{again}{rootpmap} = 1;
242	die "root op not supported, exg, we need you";	272	$self->new_img_from_root
243	}	273	}
244		274
245	=item solid $colour	275	=item solid $colour
246		276
247	=item solid $width, $height, $colour	277	=item solid $width, $height, $colour
…		…
255	=cut	285	=cut
256		286
257	sub solid($;$$) {	287	sub solid($;$$) {
258	my $colour = pop;	288	my $colour = pop;
259		289
260	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	290	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
261	$img->fill ($colour);	291	$img->fill ($colour);
262	$img	292	$img
263	}	293	}
264		294
265	=back	295	=item clone $img
266		296
267	=head2 VARIABLES	297	Returns an exact copy of the image. This is useful if you want to have
		298	multiple copies of the same image to apply different effects to.
268		299
269	The following functions provide variable data such as the terminal window
270	dimensions. They are not (Perl-) variables, they jsut return stuff that
271	varies. Most of them make your expression sensitive to some events, for
272	example using C<TW> (terminal width) means your expression is evaluated
273	again when the terminal is resized.
274
275	=over 4
276
277	=item TX
278
279	=item TY
280
281	Return the X and Y coordinates of the terminal window (the terminal
282	window is the full window by default, and the character area only when in
283	border-respect mode).
284
285	Using these functions make your expression sensitive to window moves.
286
287	These functions are mainly useful to align images to the root window.
288
289	Example: load an image and align it so it looks as if anchored to the
290	background.
291
292	move -TX, -TY, load "mybg.png"
293
294	=item TW
295
296	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
297	terminal window is the full window by default, and the character area only
298	when in border-respect mode).
299
300	Using these functions make your expression sensitive to window resizes.
301
302	These functions are mainly useful to scale images, or to clip images to
303	the window size to conserve memory.
304
305	Example: take the screen background, clip it to the window size, blur it a
306	bit, align it to the window position and use it as background.
307
308	clip move -TX, -TY, blur 5, root
309
310	=cut	300	=cut
311		301
312	sub TX() { $new->{position_sensitive} = 1; $x }
313	sub TY() { $new->{position_sensitive} = 1; $y }
314	sub TW() { $new->{size_sensitive} = 1; $w }
315	sub TH() { $new->{size_sensitive} = 1; $h }
316
317	=item now
318
319	Returns the current time as (fractional) seconds since the epoch.
320
321	Using this expression does I<not> make your expression sensitive to time,
322	but the next two functions do.
323
324	=item again $seconds
325
326	When this function is used the expression will be reevaluated again in
327	C<$seconds> seconds.
328
329	Example: load some image and rotate it according to the time of day (as if it were
330	the hour pointer of a clock). Update this image every minute.
331
332	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
333
334	=item counter $seconds
335
336	Like C<again>, but also returns an increasing counter value, starting at
337	0, which might be useful for some simple animation effects.
338
339	=cut
340
341	sub now() { urxvt::NOW }
342
343	sub again($) {
344	$new->{again} = $_[0];
345	}
346
347	sub counter($) {	302	sub clone($) {
348	$new->{again} = $_[0];	303	$_[0]->clone
349	$self->{counter} + 0
350	}	304	}
351		305
352	=back	306	=item merge $img ...
		307
		308	Takes any number of images and merges them together, creating a single
		309	image containing them all. The tiling mode of the first image is used as
		310	the tiling mdoe of the resulting image.
		311
		312	This function is called automatically when an expression returns multiple
		313	images.
		314
		315	=cut
		316
		317	sub merge(@) {
		318	return $_[0] unless $#_;
		319
		320	# rather annoyingly clumsy, but optimisation is for another time
		321
		322	my $x0 = +1e9;
		323	my $y0 = +1e9;
		324	my $x1 = -1e9;
		325	my $y1 = -1e9;
		326
		327	for (@_) {
		328	my ($x, $y, $w, $h) = $_->geometry;
		329
		330	$x0 = $x if $x0 > $x;
		331	$y0 = $y if $y0 > $y;
		332
		333	$x += $w;
		334	$y += $h;
		335
		336	$x1 = $x if $x1 < $x;
		337	$y1 = $y if $y1 < $y;
		338	}
		339
		340	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		341	$base->repeat_mode ($_[0]->repeat_mode);
		342	$base->fill ([0, 0, 0, 0]);
		343
		344	$base->draw ($_)
		345	for @_;
		346
		347	$base
		348	}
353		349
354	=head2 TILING MODES	350	=head2 TILING MODES
355		351
356	The following operators modify the tiling mode of an image, that is, the	352	The following operators modify the tiling mode of an image, that is, the
357	way that pixels outside the image area are painted when the image is used.	353	way that pixels outside the image area are painted when the image is used.
…		…
387	become transparent. This mode is most useful when you want to place an	383	become transparent. This mode is most useful when you want to place an
388	image over another image or the background colour while leaving all	384	image over another image or the background colour while leaving all
389	background pixels outside the image unchanged.	385	background pixels outside the image unchanged.
390		386
391	Example: load an image and display it in the upper left corner. The rest	387	Example: load an image and display it in the upper left corner. The rest
392	of the space is left "empty" (transparent or wahtever your compisotr does	388	of the space is left "empty" (transparent or whatever your compositor does
393	in alpha mode, else background colour).	389	in alpha mode, else background colour).
394		390
395	pad load "mybg.png"	391	pad load "mybg.png"
396		392
397	=item extend $img	393	=item extend $img
398		394
399	Extends the image over the whole plane, using the closest pixel in the	395	Extends the image over the whole plane, using the closest pixel in the
400	area outside the image. This mode is mostly useful when you more complex	396	area outside the image. This mode is mostly useful when you use more complex
401	filtering operations and want the pixels outside the image to have the	397	filtering operations and want the pixels outside the image to have the
402	same values as the pixels near the edge.	398	same values as the pixels near the edge.
403		399
404	Example: just for curiosity, how does this pixel extension stuff work?	400	Example: just for curiosity, how does this pixel extension stuff work?
405		401
…		…
431	$img	427	$img
432	}	428	}
433		429
434	=back	430	=back
435		431
436	=head2 PIXEL OPERATORS	432	=head2 VARIABLE VALUES
437		433
438	The following operators modify the image pixels in various ways.	434	The following functions provide variable data such as the terminal window
		435	dimensions. They are not (Perl-) variables, they just return stuff that
		436	varies. Most of them make your expression sensitive to some events, for
		437	example using C<TW> (terminal width) means your expression is evaluated
		438	again when the terminal is resized.
439		439
440	=over 4	440	=over 4
441		441
442	=item clone $img	442	=item TX
443		443
444	Returns an exact copy of the image.	444	=item TY
445		445
446	=cut	446	Return the X and Y coordinates of the terminal window (the terminal
		447	window is the full window by default, and the character area only when in
		448	border-respect mode).
447		449
		450	Using these functions make your expression sensitive to window moves.
		451
		452	These functions are mainly useful to align images to the root window.
		453
		454	Example: load an image and align it so it looks as if anchored to the
		455	background.
		456
		457	move -TX, -TY, load "mybg.png"
		458
		459	=item TW
		460
		461	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
		462	terminal window is the full window by default, and the character area only
		463	when in border-respect mode).
		464
		465	Using these functions make your expression sensitive to window resizes.
		466
		467	These functions are mainly useful to scale images, or to clip images to
		468	the window size to conserve memory.
		469
		470	Example: take the screen background, clip it to the window size, blur it a
		471	bit, align it to the window position and use it as background.
		472
		473	clip move -TX, -TY, once { blur 5, root }
		474
		475	=cut
		476
		477	sub TX() { $new->{again}{position} = 1; $x }
		478	sub TY() { $new->{again}{position} = 1; $y }
		479	sub TW() { $new->{again}{size} = 1; $w }
		480	sub TH() { $new->{again}{size} = 1; $h }
		481
		482	=item now
		483
		484	Returns the current time as (fractional) seconds since the epoch.
		485
		486	Using this expression does I<not> make your expression sensitive to time,
		487	but the next two functions do.
		488
		489	=item again $seconds
		490
		491	When this function is used the expression will be reevaluated again in
		492	C<$seconds> seconds.
		493
		494	Example: load some image and rotate it according to the time of day (as if it were
		495	the hour pointer of a clock). Update this image every minute.
		496
		497	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
		498
		499	=item counter $seconds
		500
		501	Like C<again>, but also returns an increasing counter value, starting at
		502	0, which might be useful for some simple animation effects.
		503
		504	=cut
		505
		506	sub now() { urxvt::NOW }
		507
		508	sub again($) {
		509	$new->{again}{time} = $_[0];
		510	}
		511
448	sub clone($) {	512	sub counter($) {
449	$_[0]->clone	513	$new->{again}{time} = $_[0];
		514	$self->{counter} + 0
450	}	515	}
		516
		517	=back
		518
		519	=head2 SHAPE CHANGING OPERATORS
		520
		521	The following operators modify the shape, size or position of the image.
		522
		523	=over 4
451		524
452	=item clip $img	525	=item clip $img
453		526
454	=item clip $width, $height, $img	527	=item clip $width, $height, $img
455		528
…		…
479	$img->sub_rect ($_[0], $_[1], $w, $h)	552	$img->sub_rect ($_[0], $_[1], $w, $h)
480	}	553	}
481		554
482	=item scale $img	555	=item scale $img
483		556
484	=item scale $size_percent, $img	557	=item scale $size_factor, $img
485		558
486	=item scale $width_percent, $height_percent, $img	559	=item scale $width_factor, $height_factor, $img
487		560
488	Scales the image by the given percentages in horizontal	561	Scales the image by the given factors in horizontal
489	(C<$width_percent>) and vertical (C<$height_percent>) direction.	562	(C<$width>) and vertical (C<$height>) direction.
490		563
491	If only one percentage is give, it is used for both directions.	564	If only one factor is give, it is used for both directions.
492		565
493	If no percentages are given, scales the image to the window size without	566	If no factors are given, scales the image to the window size without
494	keeping aspect.	567	keeping aspect.
495		568
496	=item resize $width, $height, $img	569	=item resize $width, $height, $img
497		570
498	Resizes the image to exactly C<$width> times C<$height> pixels.	571	Resizes the image to exactly C<$width> times C<$height> pixels.
499		572
500	=cut	573	=item fit $img
501		574
502	#TODO: maximise, maximise_fill?	575	=item fit $width, $height, $img
		576
		577	Fits the image into the given C<$width> and C<$height> without changing
		578	aspect, or the terminal size. That means it will be shrunk or grown until
		579	the whole image fits into the given area, possibly leaving borders.
		580
		581	=item cover $img
		582
		583	=item cover $width, $height, $img
		584
		585	Similar to C<fit>, but shrinks or grows until all of the area is covered
		586	by the image, so instead of potentially leaving borders, it will cut off
		587	image data that doesn't fit.
		588
		589	=cut
503		590
504	sub scale($;$;$) {	591	sub scale($;$;$) {
505	my $img = pop;	592	my $img = pop;
506		593
507	@_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)	594	@_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
508	: @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)	595	: @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
509	: $img->scale (TW, TH)	596	: $img->scale (TW, TH)
510	}	597	}
511		598
512	sub resize($$$) {	599	sub resize($$$) {
513	my $img = pop;	600	my $img = pop;
514	$img->scale ($_[0], $_[1])	601	$img->scale ($_[0], $_[1])
		602	}
		603
		604	sub fit($;$$) {
		605	my $img = pop;
		606	my $w = ($_[0] \|\| TW) / $img->w;
		607	my $h = ($_[1] \|\| TH) / $img->h;
		608	scale +(min $w, $h), $img
		609	}
		610
		611	sub cover($;$$) {
		612	my $img = pop;
		613	my $w = ($_[0] \|\| TW) / $img->w;
		614	my $h = ($_[1] \|\| TH) / $img->h;
		615	scale +(max $w, $h), $img
515	}	616	}
516		617
517	=item move $dx, $dy, $img	618	=item move $dx, $dy, $img
518		619
519	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in	620	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
520	the vertical.	621	the vertical.
521		622
522	Example: move the image right by 20 pixels and down by 30.	623	Example: move the image right by 20 pixels and down by 30.
523		624
524	move 20, 30, ...	625	move 20, 30, ...
		626
		627	=item align $xalign, $yalign, $img
		628
		629	Aligns the image according to a factor - C<0> means the image is moved to
		630	the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
		631	exactly centered and C<1> means it touches the right or bottom edge.
		632
		633	Example: remove any visible border around an image, center it vertically but move
		634	it to the right hand side.
		635
		636	align 1, 0.5, pad $img
		637
		638	=item center $img
		639
		640	=item center $width, $height, $img
		641
		642	Centers the image, i.e. the center of the image is moved to the center of
		643	the terminal window (or the box specified by C<$width> and C<$height> if
		644	given).
		645
		646	Example: load an image and center it.
		647
		648	center pad load "mybg.png"
525		649
526	=item rootalign $img	650	=item rootalign $img
527		651
528	Moves the image so that it appears glued to the screen as opposed to the	652	Moves the image so that it appears glued to the screen as opposed to the
529	window. This gives the illusion of a larger area behind the window. It is	653	window. This gives the illusion of a larger area behind the window. It is
…		…
535	rootalign mirror load "mybg.png"	659	rootalign mirror load "mybg.png"
536		660
537	Example: take the screen background and align it, giving the illusion of	661	Example: take the screen background and align it, giving the illusion of
538	transparency as long as the window isn't in front of other windows.	662	transparency as long as the window isn't in front of other windows.
539		663
540	rootalign root	664	rootalign root
541		665
542	=cut	666	=cut
543		667
544	sub move($$;$) {	668	sub move($$;$) {
545	my $img = pop->clone;	669	my $img = pop->clone;
546	$img->move ($_[0], $_[1]);	670	$img->move ($_[0], $_[1]);
547	$img	671	$img
548	}	672	}
549		673
		674	sub align($;$$) {
		675	my $img = pop;
		676
		677	move $_[0] * (TW - $img->w),
		678	$_[1] * (TH - $img->h),
		679	$img
		680	}
		681
		682	sub center($;$$) {
		683	my $img = pop;
		684	my $w = $_[0] \|\| TW;
		685	my $h = $_[1] \|\| TH;
		686
		687	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
		688	}
		689
550	sub rootalign($) {	690	sub rootalign($) {
551	move -TX, -TY, $_[0]	691	move -TX, -TY, $_[0]
552	}	692	}
553		693
		694	=item rotate $center_x, $center_y, $degrees
		695
		696	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		697	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		698	width/height).
		699
		700	#TODO# new width, height, maybe more operators?
		701
		702	Example: rotate the image by 90 degrees
		703
		704	=cut
		705
		706	sub rotate($$$$) {
		707	my $img = pop;
		708	$img->rotate (
		709	$_[0] * ($img->w + $img->x),
		710	$_[1] * ($img->h + $img->y),
		711	$_[2] * (3.14159265 / 180),
		712	)
		713	}
		714
		715	=back
		716
		717	=head2 COLOUR MODIFICATIONS
		718
		719	The following operators change the pixels of the image.
		720
		721	=over 4
		722
554	=item contrast $factor, $img	723	=item contrast $factor, $img
555		724
556	=item contrast $r, $g, $b, $img	725	=item contrast $r, $g, $b, $img
557		726
558	=item contrast $r, $g, $b, $a, $img	727	=item contrast $r, $g, $b, $a, $img
559		728
560	Adjusts the I<contrast> of an image.	729	Adjusts the I<contrast> of an image.
561		730
562	#TODO#	731	The first form applies a single C<$factor> to red, green and blue, the
		732	second form applies separate factors to each colour channel, and the last
		733	form includes the alpha channel.
563		734
		735	Values from 0 to 1 lower the contrast, values higher than 1 increase the
		736	contrast.
		737
		738	Due to limitations in the underlying XRender extension, lowering contrast
		739	also reduces brightness, while increasing contrast currently also
		740	increases brightness.
		741
564	=item brightness $factor, $img	742	=item brightness $bias, $img
565		743
566	=item brightness $r, $g, $b, $img	744	=item brightness $r, $g, $b, $img
567		745
568	=item brightness $r, $g, $b, $a, $img	746	=item brightness $r, $g, $b, $a, $img
569		747
570	Adjusts the brightness of an image.	748	Adjusts the brightness of an image.
571		749
		750	The first form applies a single C<$bias> to red, green and blue, the
		751	second form applies separate biases to each colour channel, and the last
		752	form includes the alpha channel.
		753
		754	Values less than 0 reduce brightness, while values larger than 0 increase
		755	it. Useful range is from -1 to 1 - the former results in a black, the
		756	latter in a white picture.
		757
		758	Due to idiosyncrasies in the underlying XRender extension, biases less
		759	than zero can be I<very> slow.
		760
572	=cut	761	=cut
573		762
574	sub contrast($$;$$;$) {	763	sub contrast($$;$$;$) {
575	my $img = pop;	764	my $img = pop;
576	my ($r, $g, $b, $a) = @_;	765	my ($r, $g, $b, $a) = @_;
577		766
578	($g, $b) = ($r, $r) if @_ < 4;	767	($g, $b) = ($r, $r) if @_ < 3;
579	$a = 1 if @_ < 5;	768	$a = 1 if @_ < 4;
580		769
581	$img = $img->clone;	770	$img = $img->clone;
582	$img->contrast ($r, $g, $b, $a);	771	$img->contrast ($r, $g, $b, $a);
583	$img	772	$img
584	}	773	}
585		774
586	sub brightness($$;$$;$) {	775	sub brightness($$;$$;$) {
587	my $img = pop;	776	my $img = pop;
588	my ($r, $g, $b, $a) = @_;	777	my ($r, $g, $b, $a) = @_;
589		778
590	($g, $b) = ($r, $r) if @_ < 4;	779	($g, $b) = ($r, $r) if @_ < 3;
591	$a = 1 if @_ < 5;	780	$a = 1 if @_ < 4;
592		781
593	$img = $img->clone;	782	$img = $img->clone;
594	$img->brightness ($r, $g, $b, $a);	783	$img->brightness ($r, $g, $b, $a);
595	$img	784	$img
596	}	785	}
…		…
612	sub blur($$;$) {	801	sub blur($$;$) {
613	my $img = pop;	802	my $img = pop;
614	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	803	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
615	}	804	}
616		805
617	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	806	=back
618		807
619	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	808	=head2 OTHER STUFF
620	pointer at C<$center_x> and C<$center_y> (specified as percentage of image
621	width/height), generating a new image with width C<$new_width> and height
622	C<$new_height>.
623		809
624	#TODO# new width, height, maybe more operators?	810	Anything that didn't fit any of the other categories, even after applying
		811	force and closing our eyes.
625		812
626	Example: rotate the image by 90 degrees	813	=over 4
627		814
628	=cut	815	=item once { ... }
629		816
630	sub rotate($$$$$$) {	817	This function takes a code block as argument, that is, one or more
631	my $img = pop;	818	statements enclosed by braces.
632	$img->rotate (	819
633	$_[0],	820	The trick is that this code block is only evaluated once - future calls
634	$_[1],	821	will simply return the original image (yes, it should only be used with
635	$_[2] * $img->w * .01,	822	images).
636	$_[3] * $img->h * .01,	823
637	$_[4] * (3.14159265 / 180),	824	This can be extremely useful to avoid redoign the same slow operations
		825	again and again- for example, if your background expression takes the root
		826	background, blurs it and then root-aligns it it would have to blur the
		827	root background on every window move or resize.
		828
		829	Putting the blur into a C<once> block will make sure the blur is only done
		830	once:
		831
		832	rootlign once { blur 10, root }
		833
		834	This leaves the question of how to force reevaluation of the block, in
		835	case the root background changes: Right now, all once blocks forget that
		836	they ahve been executed before each time the root background changes (if
		837	the expression is sensitive to that) or when C<once_again> is called.
		838
		839	=item once_again
		840
		841	Resets all C<once> block as if they had never been called, i.e. on the
		842	next call they will be reevaluated again.
		843
		844	=cut
		845
		846	sub once(&) {
		847	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		848	local $new->{again};
		849	my @res = $_[0]();
		850	[$new->{again}, \@res]
638	)	851	};
		852
		853	$new->{again} = {
		854	%{ $new->{again} },
		855	%{ $once->[0] }
		856	};
		857
		858	# in scalar context we always return the first original result, which
		859	# is not quite how perl works.
		860	wantarray
		861	? @{ $once->[1] }
		862	: $once->[1][0]
		863	}
		864
		865	sub once_again() {
		866	delete $self->{once_cache};
639	}	867	}
640		868
641	=back	869	=back
642		870
643	=cut	871	=cut
…		…
684	($x, $y, $w, $h) =	912	($x, $y, $w, $h) =
685	$self->background_geometry ($self->{border});	913	$self->background_geometry ($self->{border});
686		914
687	# evaluate user expression	915	# evaluate user expression
688		916
689	my $img = eval { $self->{expr}->() };	917	my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };
690	warn $@ if $@;#d#	918	die $@ if $@;
691	die if !UNIVERSAL::isa $img, "urxvt::img";	919	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
692		920
693	$state->{size_sensitive} = 1	921	# if the expression is sensitive to external events, prepare reevaluation then
		922
		923	my $again = delete $state->{again};
		924
		925	$again->{size} = 1
694	if $img->repeat_mode != urxvt::RepeatNormal;	926	if $img->repeat_mode != urxvt::RepeatNormal;
695		927
696	# if the expression is sensitive to external events, prepare reevaluation then
697
698	my $repeat;
699
700	if (my $again = $state->{again}) {	928	if (my $again = $again->{time}) {
701	$repeat = 1;
702	my $self = $self;	929	my $self = $self;
703	$state->{timer} = $again == $old->{again}	930	$state->{timer} = $again == $old->{again}
704	? $old->{timer}	931	? $old->{timer}
705	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	932	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
706	++$self->{counter};	933	++$self->{counter};
707	$self->recalculate	934	$self->recalculate
708	});	935	});
709	}	936	}
710		937
711	if (delete $state->{position_sensitive}) {	938	if ($again->{position}) {
712	$repeat = 1;
713	$self->enable (position_change => sub { $_[0]->recalculate });	939	$self->enable (position_change => sub { $_[0]->recalculate });
714	} else {	940	} else {
715	$self->disable ("position_change");	941	$self->disable ("position_change");
716	}	942	}
717		943
718	if (delete $state->{size_sensitive}) {	944	if ($again->{size}) {
719	$repeat = 1;
720	$self->enable (size_change => sub { $_[0]->recalculate });	945	$self->enable (size_change => sub { $_[0]->recalculate });
721	} else {	946	} else {
722	$self->disable ("size_change");	947	$self->disable ("size_change");
723	}	948	}
724		949
725	if (delete $state->{rootpmap_sensitive}) {	950	if ($again->{rootpmap}) {
726	$repeat = 1;
727	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	951	$self->enable (rootpmap_change => sub {
		952	delete $_[0]{once_cache}; # this will override once-block values from
		953	$_[0]->recalculate;
		954	});
728	} else {	955	} else {
729	$self->disable ("rootpmap_change");	956	$self->disable ("rootpmap_change");
730	}	957	}
731		958
732	# clear stuff we no longer need	959	# clear stuff we no longer need
733		960
734	%$old = ();	961	%$old = ();
735		962
736	unless ($repeat) {	963	unless (%$again) {
737	delete $self->{state};	964	delete $self->{state};
738	delete $self->{expr};	965	delete $self->{expr};
739	}	966	}
740		967
741	# set background pixmap	968	# set background pixmap
…		…
746	}	973	}
747		974
748	sub on_start {	975	sub on_start {
749	my ($self) = @_;	976	my ($self) = @_;
750		977
751	my $expr = $self->x_resource ("background.expr")	978	my $expr = $self->x_resource ("%.expr")
752	or return;	979	or return;
753		980
		981	$self->has_render
		982	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		983
754	$self->set_expr (parse_expr $expr);	984	$self->set_expr (parse_expr $expr);
755	$self->{border} = $self->x_resource_boolean ("background.border");	985	$self->{border} = $self->x_resource_boolean ("%.border");
		986
		987	$MIN_INTERVAL = $self->x_resource ("%.interval");
756		988
757	()	989	()
758	}	990	}
759		991

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.42 by root, Sun Jun 10 10:42:19 2012 UTC vs. Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.42 by root, Sun Jun 10 10:42:19 2012 UTC vs.
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC