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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.41 by root, Fri Jun 8 22:21:48 2012 UTC vs.
Revision 1.61 by root, Fri Jun 15 19:50:56 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
…		…
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
…		…
252	If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is	282	If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
253	useful for solid backgrounds or for use in filtering effects.	283	useful for solid backgrounds or for use in filtering effects.
254		284
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.
		310
		311	This function is called automatically when an expression returns multiple
		312	images.
		313
		314	=cut
		315
		316	sub merge(@) {
		317	return $_[0] unless $#_;
		318
		319	# rather annoyingly clumsy, but optimisation is for another time
		320
		321	my $x0 = +1e9;
		322	my $y0 = +1e9;
		323	my $x1 = -1e9;
		324	my $y1 = -1e9;
		325
		326	for (@_) {
		327	my ($x, $y, $w, $h) = $_->geometry;
		328
		329	$x0 = $x if $x0 > $x;
		330	$y0 = $y if $y0 > $y;
		331
		332	$x += $w;
		333	$y += $h;
		334
		335	$x1 = $x if $x1 < $x;
		336	$y1 = $y if $y1 < $y;
		337	}
		338
		339	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		340	$base->fill ([0, 0, 0, 0]);
		341
		342	$base->draw ($_)
		343	for @_;
		344
		345	$base
		346	}
353		347
354	=head2 TILING MODES	348	=head2 TILING MODES
355		349
356	The following operators modify the tiling mode of an image, that is, the	350	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.	351	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	381	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	382	image over another image or the background colour while leaving all
389	background pixels outside the image unchanged.	383	background pixels outside the image unchanged.
390		384
391	Example: load an image and display it in the upper left corner. The rest	385	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	386	of the space is left "empty" (transparent or whatever your compositor does
393	in alpha mode, else background colour).	387	in alpha mode, else background colour).
394		388
395	pad load "mybg.png"	389	pad load "mybg.png"
396		390
397	=item extend $img	391	=item extend $img
398		392
399	Extends the image over the whole plane, using the closest pixel in the	393	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	394	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	395	filtering operations and want the pixels outside the image to have the
402	same values as the pixels near the edge.	396	same values as the pixels near the edge.
403		397
404	Example: just for curiosity, how does this pixel extension stuff work?	398	Example: just for curiosity, how does this pixel extension stuff work?
405		399
…		…
431	$img	425	$img
432	}	426	}
433		427
434	=back	428	=back
435		429
436	=head2 PIXEL OPERATORS	430	=head2 VARIABLE VALUES
437		431
438	The following operators modify the image pixels in various ways.	432	The following functions provide variable data such as the terminal window
		433	dimensions. They are not (Perl-) variables, they just return stuff that
		434	varies. Most of them make your expression sensitive to some events, for
		435	example using C<TW> (terminal width) means your expression is evaluated
		436	again when the terminal is resized.
439		437
440	=over 4	438	=over 4
441		439
442	=item clone $img	440	=item TX
443		441
444	Returns an exact copy of the image.	442	=item TY
445		443
446	=cut	444	Return the X and Y coordinates of the terminal window (the terminal
		445	window is the full window by default, and the character area only when in
		446	border-respect mode).
447		447
		448	Using these functions make your expression sensitive to window moves.
		449
		450	These functions are mainly useful to align images to the root window.
		451
		452	Example: load an image and align it so it looks as if anchored to the
		453	background.
		454
		455	move -TX, -TY, load "mybg.png"
		456
		457	=item TW
		458
		459	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
		460	terminal window is the full window by default, and the character area only
		461	when in border-respect mode).
		462
		463	Using these functions make your expression sensitive to window resizes.
		464
		465	These functions are mainly useful to scale images, or to clip images to
		466	the window size to conserve memory.
		467
		468	Example: take the screen background, clip it to the window size, blur it a
		469	bit, align it to the window position and use it as background.
		470
		471	clip move -TX, -TY, once { blur 5, root }
		472
		473	=cut
		474
		475	sub TX() { $new->{again}{position} = 1; $x }
		476	sub TY() { $new->{again}{position} = 1; $y }
		477	sub TW() { $new->{again}{size} = 1; $w }
		478	sub TH() { $new->{again}{size} = 1; $h }
		479
		480	=item now
		481
		482	Returns the current time as (fractional) seconds since the epoch.
		483
		484	Using this expression does I<not> make your expression sensitive to time,
		485	but the next two functions do.
		486
		487	=item again $seconds
		488
		489	When this function is used the expression will be reevaluated again in
		490	C<$seconds> seconds.
		491
		492	Example: load some image and rotate it according to the time of day (as if it were
		493	the hour pointer of a clock). Update this image every minute.
		494
		495	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
		496
		497	=item counter $seconds
		498
		499	Like C<again>, but also returns an increasing counter value, starting at
		500	0, which might be useful for some simple animation effects.
		501
		502	=cut
		503
		504	sub now() { urxvt::NOW }
		505
		506	sub again($) {
		507	$new->{again}{time} = $_[0];
		508	}
		509
448	sub clone($) {	510	sub counter($) {
449	$_[0]->clone	511	$new->{again}{time} = $_[0];
		512	$self->{counter} + 0
450	}	513	}
		514
		515	=back
		516
		517	=head2 SHAPE CHANGING OPERATORS
		518
		519	The following operators modify the shape, size or position of the image.
		520
		521	=over 4
451		522
452	=item clip $img	523	=item clip $img
453		524
454	=item clip $width, $height, $img	525	=item clip $width, $height, $img
455		526
…		…
479	$img->sub_rect ($_[0], $_[1], $w, $h)	550	$img->sub_rect ($_[0], $_[1], $w, $h)
480	}	551	}
481		552
482	=item scale $img	553	=item scale $img
483		554
484	=item scale $size_percent, $img	555	=item scale $size_factor, $img
485		556
486	=item scale $width_percent, $height_percent, $img	557	=item scale $width_factor, $height_factor, $img
487		558
488	Scales the image by the given percentages in horizontal	559	Scales the image by the given factors in horizontal
489	(C<$width_percent>) and vertical (C<$height_percent>) direction.	560	(C<$width>) and vertical (C<$height>) direction.
490		561
491	If only one percentage is give, it is used for both directions.	562	If only one factor is give, it is used for both directions.
492		563
493	If no percentages are given, scales the image to the window size without	564	If no factors are given, scales the image to the window size without
494	keeping aspect.	565	keeping aspect.
495		566
496	=item resize $width, $height, $img	567	=item resize $width, $height, $img
497		568
498	Resizes the image to exactly C<$width> times C<$height> pixels.	569	Resizes the image to exactly C<$width> times C<$height> pixels.
499		570
500	=cut	571	=item fit $img
501		572
502	#TODO: maximise, maximise_fill?	573	=item fit $width, $height, $img
		574
		575	Fits the image into the given C<$width> and C<$height> without changing
		576	aspect, or the terminal size. That means it will be shrunk or grown until
		577	the whole image fits into the given area, possibly leaving borders.
		578
		579	=item cover $img
		580
		581	=item cover $width, $height, $img
		582
		583	Similar to C<fit>, but shrinks or grows until all of the area is covered
		584	by the image, so instead of potentially leaving borders, it will cut off
		585	image data that doesn't fit.
		586
		587	=cut
503		588
504	sub scale($;$;$) {	589	sub scale($;$;$) {
505	my $img = pop;	590	my $img = pop;
506		591
507	@_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)	592	@_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
508	: @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)	593	: @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
509	: $img->scale (TW, TH)	594	: $img->scale (TW, TH)
510	}	595	}
511		596
512	sub resize($$$) {	597	sub resize($$$) {
513	my $img = pop;	598	my $img = pop;
514	$img->scale ($_[0], $_[1])	599	$img->scale ($_[0], $_[1])
		600	}
		601
		602	sub fit($;$$) {
		603	my $img = pop;
		604	my $w = ($_[0] \|\| TW) / $img->w;
		605	my $h = ($_[1] \|\| TH) / $img->h;
		606	scale +(min $w, $h), $img
		607	}
		608
		609	sub cover($;$$) {
		610	my $img = pop;
		611	my $w = ($_[0] \|\| TW) / $img->w;
		612	my $h = ($_[1] \|\| TH) / $img->h;
		613	scale +(max $w, $h), $img
515	}	614	}
516		615
517	=item move $dx, $dy, $img	616	=item move $dx, $dy, $img
518		617
519	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in	618	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
520	the vertical.	619	the vertical.
521		620
522	Example: move the image right by 20 pixels and down by 30.	621	Example: move the image right by 20 pixels and down by 30.
523		622
524	move 20, 30, ...	623	move 20, 30, ...
		624
		625	=item align $xalign, $yalign, $img
		626
		627	Aligns the image according to a factor - C<0> means the image is moved to
		628	the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
		629	exactly centered and C<1> means it touches the right or bottom edge.
		630
		631	Example: remove any visible border around an image, center it vertically but move
		632	it to the right hand side.
		633
		634	align 1, 0.5, pad $img
		635
		636	=item center $img
		637
		638	=item center $width, $height, $img
		639
		640	Centers the image, i.e. the center of the image is moved to the center of
		641	the terminal window (or the box specified by C<$width> and C<$height> if
		642	given).
		643
		644	Example: load an image and center it.
		645
		646	center pad load "mybg.png"
525		647
526	=item rootalign $img	648	=item rootalign $img
527		649
528	Moves the image so that it appears glued to the screen as opposed to the	650	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	651	window. This gives the illusion of a larger area behind the window. It is
…		…
535	rootalign mirror load "mybg.png"	657	rootalign mirror load "mybg.png"
536		658
537	Example: take the screen background and align it, giving the illusion of	659	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.	660	transparency as long as the window isn't in front of other windows.
539		661
540	rootalign root	662	rootalign root
541		663
542	=cut	664	=cut
543		665
544	sub move($$;$) {	666	sub move($$;$) {
545	my $img = pop->clone;	667	my $img = pop->clone;
546	$img->move ($_[0], $_[1]);	668	$img->move ($_[0], $_[1]);
547	$img	669	$img
548	}	670	}
549		671
		672	sub align($;$$) {
		673	my $img = pop;
		674
		675	move $_[0] * (TW - $img->w),
		676	$_[1] * (TH - $img->h),
		677	$img
		678	}
		679
		680	sub center($;$$) {
		681	my $img = pop;
		682	my $w = $_[0] \|\| TW;
		683	my $h = $_[1] \|\| TH;
		684
		685	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
		686	}
		687
550	sub rootalign($) {	688	sub rootalign($) {
551	move -TX, -TY, $_[0]	689	move -TX, -TY, $_[0]
552	}	690	}
553		691
		692	=item rotate $center_x, $center_y, $degrees
		693
		694	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		695	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		696	width/height).
		697
		698	#TODO# new width, height, maybe more operators?
		699
		700	Example: rotate the image by 90 degrees
		701
		702	=cut
		703
		704	sub rotate($$$$) {
		705	my $img = pop;
		706	$img->rotate (
		707	$_[0] * ($img->w + $img->x),
		708	$_[1] * ($img->h + $img->y),
		709	$_[2] * (3.14159265 / 180),
		710	)
		711	}
		712
		713	=back
		714
		715	=head2 COLOUR MODIFICATIONS
		716
		717	The following operators change the pixels of the image.
		718
		719	=over 4
		720
554	=item contrast $factor, $img	721	=item contrast $factor, $img
555		722
556	=item contrast $r, $g, $b, $img	723	=item contrast $r, $g, $b, $img
557		724
558	=item contrast $r, $g, $b, $a, $img	725	=item contrast $r, $g, $b, $a, $img
559		726
560	Adjusts the I<contrast> of an image.	727	Adjusts the I<contrast> of an image.
561		728
562	#TODO#	729	The first form applies a single C<$factor> to red, green and blue, the
		730	second form applies separate factors to each colour channel, and the last
		731	form includes the alpha channel.
563		732
		733	Values from 0 to 1 lower the contrast, values higher than 1 increase the
		734	contrast.
		735
		736	Due to limitations in the underlying XRender extension, lowering contrast
		737	also reduces brightness, while increasing contrast currently also
		738	increases brightness.
		739
564	=item brightness $factor, $img	740	=item brightness $bias, $img
565		741
566	=item brightness $r, $g, $b, $img	742	=item brightness $r, $g, $b, $img
567		743
568	=item brightness $r, $g, $b, $a, $img	744	=item brightness $r, $g, $b, $a, $img
569		745
570	Adjusts the brightness of an image.	746	Adjusts the brightness of an image.
571		747
		748	The first form applies a single C<$bias> to red, green and blue, the
		749	second form applies separate biases to each colour channel, and the last
		750	form includes the alpha channel.
		751
		752	Values less than 0 reduce brightness, while values larger than 0 increase
		753	it. Useful range is from -1 to 1 - the former results in a black, the
		754	latter in a white picture.
		755
		756	Due to idiosyncrasies in the underlying XRender extension, biases less
		757	than zero can be I<very> slow.
		758
572	=cut	759	=cut
573		760
574	sub contrast($$;$$;$) {	761	sub contrast($$;$$;$) {
575	my $img = pop;	762	my $img = pop;
576	my ($r, $g, $b, $a) = @_;	763	my ($r, $g, $b, $a) = @_;
577		764
578	($g, $b) = ($r, $r) if @_ < 4;	765	($g, $b) = ($r, $r) if @_ < 3;
579	$a = 1 if @_ < 5;	766	$a = 1 if @_ < 4;
580		767
581	$img = $img->clone;	768	$img = $img->clone;
582	$img->contrast ($r, $g, $b, $a);	769	$img->contrast ($r, $g, $b, $a);
583	$img	770	$img
584	}	771	}
585		772
586	sub brightness($$;$$;$) {	773	sub brightness($$;$$;$) {
587	my $img = pop;	774	my $img = pop;
588	my ($r, $g, $b, $a) = @_;	775	my ($r, $g, $b, $a) = @_;
589		776
590	($g, $b) = ($r, $r) if @_ < 4;	777	($g, $b) = ($r, $r) if @_ < 3;
591	$a = 1 if @_ < 5;	778	$a = 1 if @_ < 4;
592		779
593	$img = $img->clone;	780	$img = $img->clone;
594	$img->brightness ($r, $g, $b, $a);	781	$img->brightness ($r, $g, $b, $a);
595	$img	782	$img
596	}	783	}
…		…
612	sub blur($$;$) {	799	sub blur($$;$) {
613	my $img = pop;	800	my $img = pop;
614	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	801	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
615	}	802	}
616		803
617	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	804	=back
618		805
619	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	806	=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		807
624	#TODO# new width, height, maybe more operators?	808	Anything that didn't fit any of the other categories, even after applying
		809	force and closing our eyes.
625		810
626	Example: rotate the image by 90 degrees	811	=over 4
627		812
628	=cut	813	=item once { ... }
629		814
630	sub rotate($$$$$$) {	815	This function takes a code block as argument, that is, one or more
631	my $img = pop;	816	statements enclosed by braces.
632	$img->rotate (	817
633	$_[0],	818	The trick is that this code block is only evaluated once - future calls
634	$_[1],	819	will simply return the original image (yes, it should only be used with
635	$_[2] * $img->w * .01,	820	images).
636	$_[3] * $img->h * .01,	821
637	$_[4] * (3.14159265 / 180),	822	This can be extremely useful to avoid redoign the same slow operations
		823	again and again- for example, if your background expression takes the root
		824	background, blurs it and then root-aligns it it would have to blur the
		825	root background on every window move or resize.
		826
		827	Putting the blur into a C<once> block will make sure the blur is only done
		828	once:
		829
		830	rootlign once { blur 10, root }
		831
		832	This leaves the question of how to force reevaluation of the block, in
		833	case the root background changes: Right now, all once blocks forget that
		834	they ahve been executed before each time the root background changes (if
		835	the expression is sensitive to that) or when C<once_again> is called.
		836
		837	=item once_again
		838
		839	Resets all C<once> block as if they had never been called, i.e. on the
		840	next call they will be reevaluated again.
		841
		842	=cut
		843
		844	sub once(&) {
		845	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		846	local $new->{again};
		847	my @res = $_[0]();
		848	[$new->{again}, \@res]
638	)	849	};
		850
		851	$new->{again} = {
		852	%{ $new->{again} },
		853	%{ $once->[0] }
		854	};
		855
		856	# in scalar context we always return the first original result, which
		857	# is not quite how perl works.
		858	wantarray
		859	? @{ $once->[1] }
		860	: $once->[1][0]
		861	}
		862
		863	sub once_again() {
		864	delete $self->{once_cache};
639	}	865	}
640		866
641	=back	867	=back
642		868
643	=cut	869	=cut
…		…
684	($x, $y, $w, $h) =	910	($x, $y, $w, $h) =
685	$self->background_geometry ($self->{border});	911	$self->background_geometry ($self->{border});
686		912
687	# evaluate user expression	913	# evaluate user expression
688		914
689	my $img = eval { $self->{expr}->() };	915	my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };
690	warn $@ if $@;#d#	916	die $@ if $@;
691	die if !UNIVERSAL::isa $img, "urxvt::img";	917	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
692		918
693	$state->{size_sensitive} = 1	919	# if the expression is sensitive to external events, prepare reevaluation then
		920
		921	my $again = delete $state->{again};
		922
		923	$again->{size} = 1
694	if $img->repeat_mode != urxvt::RepeatNormal;	924	if $img->repeat_mode != urxvt::RepeatNormal;
695		925
696	# if the expression is sensitive to external events, prepare reevaluation then
697
698	my $repeat;
699
700	if (my $again = $state->{again}) {	926	if (my $again = $again->{time}) {
701	$repeat = 1;
702	my $self = $self;	927	my $self = $self;
703	$state->{timer} = $again == $old->{again}	928	$state->{timer} = $again == $old->{again}
704	? $old->{timer}	929	? $old->{timer}
705	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	930	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
706	++$self->{counter};	931	++$self->{counter};
707	$self->recalculate	932	$self->recalculate
708	});	933	});
709	}	934	}
710		935
711	if (delete $state->{position_sensitive}) {	936	if ($again->{position}) {
712	$repeat = 1;
713	$self->enable (position_change => sub { $_[0]->recalculate });	937	$self->enable (position_change => sub { $_[0]->recalculate });
714	} else {	938	} else {
715	$self->disable ("position_change");	939	$self->disable ("position_change");
716	}	940	}
717		941
718	if (delete $state->{size_sensitive}) {	942	if ($again->{size}) {
719	$repeat = 1;
720	$self->enable (size_change => sub { $_[0]->recalculate });	943	$self->enable (size_change => sub { $_[0]->recalculate });
721	} else {	944	} else {
722	$self->disable ("size_change");	945	$self->disable ("size_change");
723	}	946	}
724		947
725	if (delete $state->{rootpmap_sensitive}) {	948	if ($again->{rootpmap}) {
726	$repeat = 1;
727	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	949	$self->enable (rootpmap_change => sub {
		950	delete $_[0]{once_cache}; # this will override once-block values from
		951	$_[0]->recalculate;
		952	});
728	} else {	953	} else {
729	$self->disable ("rootpmap_change");	954	$self->disable ("rootpmap_change");
730	}	955	}
731		956
732	# clear stuff we no longer need	957	# clear stuff we no longer need
733		958
734	%$old = ();	959	%$old = ();
735		960
736	unless ($repeat) {	961	unless (%$again) {
737	delete $self->{state};	962	delete $self->{state};
738	delete $self->{expr};	963	delete $self->{expr};
739	}	964	}
740		965
741	# set background pixmap	966	# set background pixmap
…		…
746	}	971	}
747		972
748	sub on_start {	973	sub on_start {
749	my ($self) = @_;	974	my ($self) = @_;
750		975
751	my $expr = $self->x_resource ("background.expr")	976	my $expr = $self->x_resource ("%.expr")
752	or return;	977	or return;
753		978
		979	$self->has_render
		980	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		981
754	$self->set_expr (parse_expr $expr);	982	$self->set_expr (parse_expr $expr);
755	$self->{border} = $self->x_resource_boolean ("background.border");	983	$self->{border} = $self->x_resource_boolean ("%.border");
		984
		985	$MIN_INTERVAL = $self->x_resource ("%.interval");
756		986
757	()	987	()
758	}	988	}
759		989

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.41 by root, Fri Jun 8 22:21:48 2012 UTC vs. Revision 1.61 by root, Fri Jun 15 19:50:56 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.41 by root, Fri Jun 8 22:21:48 2012 UTC vs.
Revision 1.61 by root, Fri Jun 15 19:50:56 2012 UTC