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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.49 by root, Sun Jun 10 15:29:18 2012 UTC vs.
Revision 1.89 by root, Sat Dec 13 12:24:33 2014 UTC

…		…
1	#! perl	1	#! perl
2		2
3	#:META:X_RESOURCE:%.expr:string:background expression	3	#:META:RESOURCE:%.expr:string:background expression
4	#:META:X_RESOURCE:%.border:boolean:respect the terminal border	4	#:META:RESOURCE:%.border:boolean:respect the terminal border
5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates	5	#:META:RESOURCE:%.interval:seconds:minimum time between updates
6
7	#TODO: once, rootalign
8		6
9	=head1 NAME	7	=head1 NAME
10		8
11	background - manage terminal background	9	background - manage terminal background
12		10
13	=head1 SYNOPSIS	11	=head1 SYNOPSIS
14		12
15	urxvt --background-expr 'background expression'	13	urxvt --background-expr 'background expression'
16	--background-border	14	--background-border
17	--background-interval seconds	15	--background-interval seconds
18		16
		17	=head1 QUICK AND DIRTY CHEAT SHEET
		18
		19	Just load a random jpeg image and tile the background with it without
		20	scaling or anything else:
		21
		22	load "/path/to/img.jpg"
		23
		24	The same, but use mirroring/reflection instead of tiling:
		25
		26	mirror load "/path/to/img.jpg"
		27
		28	Load an image and scale it to exactly fill the terminal window:
		29
		30	scale keep { load "/path/to/img.jpg" }
		31
		32	Implement pseudo-transparency by using a suitably-aligned root pixmap
		33	as window background:
		34
		35	rootalign root
		36
		37	Likewise, but keep a blurred copy:
		38
		39	rootalign keep { blur 10, root }
		40
19	=head1 DESCRIPTION	41	=head1 DESCRIPTION
20		42
21	This extension manages the terminal background by creating a picture that	43	This extension manages the terminal background by creating a picture that
22	is behind the text, replacing the normal background colour.	44	is behind the text, replacing the normal background colour.
23		45
28	to be as simple as possible.	50	to be as simple as possible.
29		51
30	For example, to load an image and scale it to the window size, you would	52	For example, to load an image and scale it to the window size, you would
31	use:	53	use:
32		54
33	urxvt --background-expr 'scale load "/path/to/mybg.png"'	55	urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
34		56
35	Or specified as a X resource:	57	Or specified as a X resource:
36		58
37	URxvt.background-expr: scale load "/path/to/mybg.png"	59	URxvt.background-expr: scale keep { load "/path/to/mybg.png" }
38		60
39	=head1 THEORY OF OPERATION	61	=head1 THEORY OF OPERATION
40		62
41	At startup, just before the window is mapped for the first time, the	63	At startup, just before the window is mapped for the first time, the
42	expression is evaluated and must yield an image. The image is then	64	expression is evaluated and must yield an image. The image is then
…		…
55	If any of the parameters that the expression relies on changes (when the	77	If any of the parameters that the expression relies on changes (when the
56	window is moved or resized, its position or size changes; when the root	78	window is moved or resized, its position or size changes; when the root
57	pixmap is replaced by another one the root background changes; or when the	79	pixmap is replaced by another one the root background changes; or when the
58	timer elapses), then the expression will be evaluated again.	80	timer elapses), then the expression will be evaluated again.
59		81
60	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the	82	For example, an expression such as C<scale keep { load "$HOME/mybg.png"
61	image to the window size, so it relies on the window size and will	83	}> scales the image to the window size, so it relies on the window size
62	be reevaluated each time it is changed, but not when it moves for	84	and will be reevaluated each time it is changed, but not when it moves for
63	example. That ensures that the picture always fills the terminal, even	85	example. That ensures that the picture always fills the terminal, even
64	after it's size changes.	86	after its size changes.
65		87
66	=head2 EXPRESSIONS	88	=head2 EXPRESSIONS
67		89
68	Expressions are normal Perl expressions, in fact, they are Perl blocks -	90	Expressions are normal Perl expressions, in fact, they are Perl blocks -
69	which means you could use multiple lines and statements:	91	which means you could use multiple lines and statements:
70		92
		93	scale keep {
71	again 3600;	94	again 3600;
72	if (localtime now)[6]) {	95	if (localtime now)[6]) {
73	return scale load "$HOME/weekday.png";	96	return load "$HOME/weekday.png";
74	} else {	97	} else {
75	return scale load "$HOME/sunday.png";	98	return load "$HOME/sunday.png";
		99	}
76	}	100	}
77		101
78	This expression gets evaluated once per hour. It will set F<sunday.png> as	102	This inner expression is evaluated once per hour (and whenever the
		103	terminal window is resized). It sets F<sunday.png> as background on
79	background on Sundays, and F<weekday.png> on all other days.	104	Sundays, and F<weekday.png> on all other days.
80		105
81	Fortunately, we expect that most expressions will be much simpler, with	106	Fortunately, we expect that most expressions will be much simpler, with
82	little Perl knowledge needed.	107	little Perl knowledge needed.
83		108
84	Basically, you always start with a function that "generates" an image	109	Basically, you always start with a function that "generates" an image
…		…
117	horizontal and vertical dimensions. For example, this halves the image	142	horizontal and vertical dimensions. For example, this halves the image
118	width and doubles the image height:	143	width and doubles the image height:
119		144
120	scale 0.5, 2, load "$HOME/mypic.png"	145	scale 0.5, 2, load "$HOME/mypic.png"
121		146
122	Other effects than scalign are also readily available, for exmaple, you can	147	IF you try out these expressions, you might suffer from some sluggishness,
123	tile the image to fill the whole window, instead of resizing it:	148	because each time the terminal is resized, it loads the PNG image again
		149	and scales it. Scaling is usually fast (and unavoidable), but loading the
		150	image can be quite time consuming. This is where C<keep> comes in handy:
124		151
		152	scale 0.5, 2, keep { load "$HOME/mypic.png" }
		153
		154	The C<keep> operator executes all the statements inside the braces only
		155	once, or when it thinks the outcome might change. In other cases it
		156	returns the last value computed by the brace block.
		157
		158	This means that the C<load> is only executed once, which makes it much
		159	faster, but also means that more memory is being used, because the loaded
		160	image must be kept in memory at all times. In this expression, the
		161	trade-off is likely worth it.
		162
		163	But back to effects: Other effects than scaling are also readily
		164	available, for example, you can tile the image to fill the whole window,
		165	instead of resizing it:
		166
125	tile load "$HOME/mypic.png"	167	tile keep { load "$HOME/mypic.png" }
126		168
127	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator	169	In fact, images returned by C<load> are in C<tile> mode by default, so the
128	is kind of superfluous.	170	C<tile> operator is kind of superfluous.
129		171
130	Another common effect is to mirror the image, so that the same edges touch:	172	Another common effect is to mirror the image, so that the same edges
		173	touch:
131		174
132	mirror load "$HOME/mypic.png"	175	mirror keep { load "$HOME/mypic.png" }
133		176
134	This is also a typical background expression:	177	Another common background expression is:
135		178
136	rootalign root	179	rootalign root
137		180
138	It first takes a snapshot of the screen background image, and then	181	This one first takes a snapshot of the screen background image, and then
139	moves it to the upper left corner of the screen - the result is	182	moves it to the upper left corner of the screen (as opposed to the upper
140	pseudo-transparency, as the image seems to be static while the window is	183	left corner of the terminal window)- the result is pseudo-transparency:
141	moved around.	184	the image seems to be static while the window is moved around.
142		185
143	=head2 CYCLES AND CACHING	186	=head2 COLOUR SPECIFICATIONS
144		187
145	As has been mentioned before, the expression might be evaluated multiple	188	Whenever an operator expects a "colour", then this can be specified in one
146	times. Each time the expression is reevaluated, a new cycle is said to	189	of two ways: Either as string with an X11 colour specification, such as:
147	have begun. Many operators cache their results till the next cycle.
148		190
149	For example, the C<load> operator keeps a copy of the image. If it is	191	"red" # named colour
150	asked to load the same image on the next cycle it will not load it again,	192	"#f00" # simple rgb
151	but return the cached copy.	193	"[50]red" # red with 50% alpha
		194	"TekHVC:300/50/50" # anything goes
152		195
153	This only works for one cycle though, so as long as you load the same	196	OR as an array reference with one, three or four components:
154	image every time, it will always be cached, but when you load a different
155	image, it will forget about the first one.
156		197
157	This allows you to either speed things up by keeping multiple images in	198	[0.5] # 50% gray, 100% alpha
158	memory, or comserve memory by loading images more often.	199	[0.5, 0, 0] # dark red, no green or blur, 100% alpha
		200	[0.5, 0, 0, 0.7] # same with explicit 70% alpha
159		201
160	For example, you can keep two images in memory and use a random one like	202	=head2 CACHING AND SENSITIVITY
161	this:
162		203
163	my $img1 = load "img1.png";	204	Since some operations (such as C<load> and C<blur>) can take a long time,
164	my $img2 = load "img2.png";	205	caching results can be very important for a smooth operation. Caching can
165	(0.5 > rand) ? $img1 : $img2	206	also be useful to reduce memory usage, though, for example, when an image
		207	is cached by C<load>, it could be shared by multiple terminal windows
		208	running inside urxvtd.
166		209
167	Since both images are "loaded" every time the expression is evaluated,	210	=head3 C<keep { ... }> caching
168	they are always kept in memory. Contrast this version:
169		211
170	my $path1 = "img1.png";	212	The most important way to cache expensive operations is to use C<keep {
171	my $path2 = "img2.png";	213	... }>. The C<keep> operator takes a block of multiple statements enclosed
172	load ((0.5 > rand) ? $path1 : $path2)	214	by C<{}> and keeps the return value in memory.
173		215
174	Here, a path is selected randomly, and load is only called for one image,	216	An expression can be "sensitive" to various external events, such as
175	so keeps only one image in memory. If, on the next evaluation, luck	217	scaling or moving the window, root background changes and timers. Simply
176	decides to use the other path, then it will have to load that image again.	218	using an expression (such as C<scale> without parameters) that depends on
		219	certain changing values (called "variables"), or using those variables
		220	directly, will make an expression sensitive to these events - for example,
		221	using C<scale> or C<TW> will make the expression sensitive to the terminal
		222	size, and thus to resizing events.
		223
		224	When such an event happens, C<keep> will automatically trigger a
		225	reevaluation of the whole expression with the new value of the expression.
		226
		227	C<keep> is most useful for expensive operations, such as C<blur>:
		228
		229	rootalign keep { blur 20, root }
		230
		231	This makes a blurred copy of the root background once, and on subsequent
		232	calls, just root-aligns it. Since C<blur> is usually quite slow and
		233	C<rootalign> is quite fast, this trades extra memory (for the cached
		234	blurred pixmap) with speed (blur only needs to be redone when root
		235	changes).
		236
		237	=head3 C<load> caching
		238
		239	The C<load> operator itself does not keep images in memory, but as long as
		240	the image is still in memory, C<load> will use the in-memory image instead
		241	of loading it freshly from disk.
		242
		243	That means that this expression:
		244
		245	keep { load "$HOME/path..." }
		246
		247	Not only caches the image in memory, other terminal instances that try to
		248	C<load> it can reuse that in-memory copy.
177		249
178	=head1 REFERENCE	250	=head1 REFERENCE
179		251
180	=head2 COMMAND LINE SWITCHES	252	=head2 COMMAND LINE SWITCHES
181		253
…		…
193	Specifying this flag changes the behaviour, so that the image only	265	Specifying this flag changes the behaviour, so that the image only
194	replaces the background of the character area.	266	replaces the background of the character area.
195		267
196	=item --background-interval seconds	268	=item --background-interval seconds
197		269
198	Since some operations in the underlying XRender extension can effetively	270	Since some operations in the underlying XRender extension can effectively
199	freeze your X-server for prolonged time, this extension enforces a minimum	271	freeze your X-server for prolonged time, this extension enforces a minimum
200	time between updates, which is normally about 0.1 seconds.	272	time between updates, which is normally about 0.1 seconds.
201		273
202	If you want to do updates more often, you can decrease this safety	274	If you want to do updates more often, you can decrease this safety
203	interval with this switch.	275	interval with this switch.
204		276
205	=back	277	=back
206		278
207	=cut	279	=cut
208		280
209	our %_IMGCACHE;	281	our %_IMG_CACHE;
210	our $HOME;	282	our $HOME;
211	our ($self, $old, $new);	283	our ($self, $frame);
212	our ($x, $y, $w, $h);	284	our ($x, $y, $w, $h, $focus);
213		285
214	# enforce at least this interval between updates	286	# enforce at least this interval between updates
215	our $MIN_INTERVAL = 6/59.951;	287	our $MIN_INTERVAL = 6/59.951;
216		288
217	{	289	{
218	package urxvt::bgdsl; # background language	290	package urxvt::bgdsl; # background language
		291
		292	sub FR_PARENT() { 0 } # parent frame, if any - must be #0
		293	sub FR_CACHE () { 1 } # cached values
		294	sub FR_AGAIN () { 2 } # what this expr is sensitive to
		295	sub FR_STATE () { 3 } # watchers etc.
219		296
220	use List::Util qw(min max sum shuffle);	297	use List::Util qw(min max sum shuffle);
221		298
222	=head2 PROVIDERS/GENERATORS	299	=head2 PROVIDERS/GENERATORS
223		300
…		…
230	=item load $path	307	=item load $path
231		308
232	Loads the image at the given C<$path>. The image is set to plane tiling	309	Loads the image at the given C<$path>. The image is set to plane tiling
233	mode.	310	mode.
234		311
235	Loaded images will be cached for one cycle.	312	If the image is already in memory (e.g. because another terminal instance
		313	uses it), then the in-memory copy is returned instead.
236		314
		315	=item load_uc $path
		316
		317	Load uncached - same as load, but does not cache the image, which means it
		318	is I<always> loaded from the filesystem again, even if another copy of it
		319	is in memory at the time.
		320
237	=cut	321	=cut
		322
		323	sub load_uc($) {
		324	$self->new_img_from_file ($_[0])
		325	}
238		326
239	sub load($) {	327	sub load($) {
240	my ($path) = @_;	328	my ($path) = @_;
241		329
242	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	330	$_IMG_CACHE{$path} \|\| do {
		331	my $img = load_uc $path;
		332	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		333	$img
		334	}
243	}	335	}
244		336
245	=item root	337	=item root
246		338
247	Returns the root window pixmap, that is, hopefully, the background image	339	Returns the root window pixmap, that is, hopefully, the background image
248	of your screen. The image is set to extend mode.	340	of your screen.
249		341
250	This function makes your expression root sensitive, that means it will be	342	This function makes your expression root sensitive, that means it will be
251	reevaluated when the bg image changes.	343	reevaluated when the bg image changes.
252		344
253	=cut	345	=cut
254		346
255	sub root() {	347	sub root() {
256	$new->{rootpmap_sensitive} = 1;	348	$frame->[FR_AGAIN]{rootpmap} = 1;
257	die "root op not supported, exg, we need you";	349	$self->new_img_from_root
258	}	350	}
259		351
260	=item solid $colour	352	=item solid $colour
261		353
262	=item solid $width, $height, $colour	354	=item solid $width, $height, $colour
…		…
270	=cut	362	=cut
271		363
272	sub solid($;$$) {	364	sub solid($;$$) {
273	my $colour = pop;	365	my $colour = pop;
274		366
275	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	367	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
276	$img->fill ($colour);	368	$img->fill ($colour);
277	$img	369	$img
278	}	370	}
279		371
280	=item clone $img	372	=item clone $img
…		…
284		376
285	=cut	377	=cut
286		378
287	sub clone($) {	379	sub clone($) {
288	$_[0]->clone	380	$_[0]->clone
		381	}
		382
		383	=item merge $img ...
		384
		385	Takes any number of images and merges them together, creating a single
		386	image containing them all. The tiling mode of the first image is used as
		387	the tiling mode of the resulting image.
		388
		389	This function is called automatically when an expression returns multiple
		390	images.
		391
		392	=cut
		393
		394	sub merge(@) {
		395	return $_[0] unless $#_;
		396
		397	# rather annoyingly clumsy, but optimisation is for another time
		398
		399	my $x0 = +1e9;
		400	my $y0 = +1e9;
		401	my $x1 = -1e9;
		402	my $y1 = -1e9;
		403
		404	for (@_) {
		405	my ($x, $y, $w, $h) = $_->geometry;
		406
		407	$x0 = $x if $x0 > $x;
		408	$y0 = $y if $y0 > $y;
		409
		410	$x += $w;
		411	$y += $h;
		412
		413	$x1 = $x if $x1 < $x;
		414	$y1 = $y if $y1 < $y;
		415	}
		416
		417	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		418	$base->repeat_mode ($_[0]->repeat_mode);
		419	$base->fill ([0, 0, 0, 0]);
		420
		421	$base->draw ($_)
		422	for @_;
		423
		424	$base
289	}	425	}
290		426
291	=back	427	=back
292		428
293	=head2 TILING MODES	429	=head2 TILING MODES
…		…
326	become transparent. This mode is most useful when you want to place an	462	become transparent. This mode is most useful when you want to place an
327	image over another image or the background colour while leaving all	463	image over another image or the background colour while leaving all
328	background pixels outside the image unchanged.	464	background pixels outside the image unchanged.
329		465
330	Example: load an image and display it in the upper left corner. The rest	466	Example: load an image and display it in the upper left corner. The rest
331	of the space is left "empty" (transparent or wahtever your compisotr does	467	of the space is left "empty" (transparent or whatever your compositor does
332	in alpha mode, else background colour).	468	in alpha mode, else background colour).
333		469
334	pad load "mybg.png"	470	pad load "mybg.png"
335		471
336	=item extend $img	472	=item extend $img
337		473
338	Extends the image over the whole plane, using the closest pixel in the	474	Extends the image over the whole plane, using the closest pixel in the
339	area outside the image. This mode is mostly useful when you more complex	475	area outside the image. This mode is mostly useful when you use more complex
340	filtering operations and want the pixels outside the image to have the	476	filtering operations and want the pixels outside the image to have the
341	same values as the pixels near the edge.	477	same values as the pixels near the edge.
342		478
343	Example: just for curiosity, how does this pixel extension stuff work?	479	Example: just for curiosity, how does this pixel extension stuff work?
344		480
…		…
388		524
389	Return the X and Y coordinates of the terminal window (the terminal	525	Return the X and Y coordinates of the terminal window (the terminal
390	window is the full window by default, and the character area only when in	526	window is the full window by default, and the character area only when in
391	border-respect mode).	527	border-respect mode).
392		528
393	Using these functions make your expression sensitive to window moves.	529	Using these functions makes your expression sensitive to window moves.
394		530
395	These functions are mainly useful to align images to the root window.	531	These functions are mainly useful to align images to the root window.
396		532
397	Example: load an image and align it so it looks as if anchored to the	533	Example: load an image and align it so it looks as if anchored to the
398	background.	534	background (that's exactly what C<rootalign> does btw.):
399		535
400	move -TX, -TY, load "mybg.png"	536	move -TX, -TY, keep { load "mybg.png" }
401		537
402	=item TW	538	=item TW
		539
		540	=item TH
403		541
404	Return the width (C<TW>) and height (C<TH>) of the terminal window (the	542	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
405	terminal window is the full window by default, and the character area only	543	terminal window is the full window by default, and the character area only
406	when in border-respect mode).	544	when in border-respect mode).
407		545
408	Using these functions make your expression sensitive to window resizes.	546	Using these functions makes your expression sensitive to window resizes.
409		547
410	These functions are mainly useful to scale images, or to clip images to	548	These functions are mainly useful to scale images, or to clip images to
411	the window size to conserve memory.	549	the window size to conserve memory.
412		550
413	Example: take the screen background, clip it to the window size, blur it a	551	Example: take the screen background, clip it to the window size, blur it a
414	bit, align it to the window position and use it as background.	552	bit, align it to the window position and use it as background.
415		553
416	clip move -TX, -TY, blur 5, root	554	clip move -TX, -TY, keep { blur 5, root }
417		555
418	=cut	556	=item FOCUS
419		557
420	sub TX() { $new->{position_sensitive} = 1; $x }	558	Returns a boolean indicating whether the terminal window has keyboard
421	sub TY() { $new->{position_sensitive} = 1; $y }	559	focus, in which case it returns true.
422	sub TW() { $new->{size_sensitive} = 1; $w }	560
423	sub TH() { $new->{size_sensitive} = 1; $h }	561	Using this function makes your expression sensitive to focus changes.
		562
		563	A common use case is to fade the background image when the terminal loses
		564	focus, often together with the C<-fade> command line option. In fact,
		565	there is a special function for just that use case: C<focus_fade>.
		566
		567	Example: use two entirely different background images, depending on
		568	whether the window has focus.
		569
		570	FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" }
		571
		572	=cut
		573
		574	sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
		575	sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
		576	sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
		577	sub TH () { $frame->[FR_AGAIN]{size} = 1; $h }
		578	sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus }
424		579
425	=item now	580	=item now
426		581
427	Returns the current time as (fractional) seconds since the epoch.	582	Returns the current time as (fractional) seconds since the epoch.
428		583
…		…
435	C<$seconds> seconds.	590	C<$seconds> seconds.
436		591
437	Example: load some image and rotate it according to the time of day (as if it were	592	Example: load some image and rotate it according to the time of day (as if it were
438	the hour pointer of a clock). Update this image every minute.	593	the hour pointer of a clock). Update this image every minute.
439		594
		595	again 60;
440	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	596	rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
441		597
442	=item counter $seconds	598	=item counter $seconds
443		599
444	Like C<again>, but also returns an increasing counter value, starting at	600	Like C<again>, but also returns an increasing counter value, starting at
445	0, which might be useful for some simple animation effects.	601	0, which might be useful for some simple animation effects.
…		…
447	=cut	603	=cut
448		604
449	sub now() { urxvt::NOW }	605	sub now() { urxvt::NOW }
450		606
451	sub again($) {	607	sub again($) {
452	$new->{again} = $_[0];	608	$frame->[FR_AGAIN]{time} = $_[0];
453	}	609	}
454		610
455	sub counter($) {	611	sub counter($) {
456	$new->{again} = $_[0];	612	$frame->[FR_AGAIN]{time} = $_[0];
457	$self->{counter} + 0	613	$frame->[FR_STATE]{counter} + 0
458	}	614	}
459		615
460	=back	616	=back
461		617
462	=head2 SHAPE CHANGING OPERATORS	618	=head2 SHAPE CHANGING OPERATORS
…		…
474	Clips an image to the given rectangle. If the rectangle is outside the	630	Clips an image to the given rectangle. If the rectangle is outside the
475	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is	631	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
476	larger than the image, then the tiling mode defines how the extra pixels	632	larger than the image, then the tiling mode defines how the extra pixels
477	will be filled.	633	will be filled.
478		634
479	If C<$x> an C<$y> are missing, then C<0> is assumed for both.	635	If C<$x> and C<$y> are missing, then C<0> is assumed for both.
480		636
481	If C<$width> and C<$height> are missing, then the window size will be	637	If C<$width> and C<$height> are missing, then the window size will be
482	assumed.	638	assumed.
483		639
484	Example: load an image, blur it, and clip it to the window size to save	640	Example: load an image, blur it, and clip it to the window size to save
485	memory.	641	memory.
486		642
487	clip blur 10, load "mybg.png"	643	clip keep { blur 10, load "mybg.png" }
488		644
489	=cut	645	=cut
490		646
491	sub clip($;$$;$$) {	647	sub clip($;$$;$$) {
492	my $img = pop;	648	my $img = pop;
…		…
502	=item scale $width_factor, $height_factor, $img	658	=item scale $width_factor, $height_factor, $img
503		659
504	Scales the image by the given factors in horizontal	660	Scales the image by the given factors in horizontal
505	(C<$width>) and vertical (C<$height>) direction.	661	(C<$width>) and vertical (C<$height>) direction.
506		662
507	If only one factor is give, it is used for both directions.	663	If only one factor is given, it is used for both directions.
508		664
509	If no factors are given, scales the image to the window size without	665	If no factors are given, scales the image to the window size without
510	keeping aspect.	666	keeping aspect.
511		667
512	=item resize $width, $height, $img	668	=item resize $width, $height, $img
…		…
586	the terminal window (or the box specified by C<$width> and C<$height> if	742	the terminal window (or the box specified by C<$width> and C<$height> if
587	given).	743	given).
588		744
589	Example: load an image and center it.	745	Example: load an image and center it.
590		746
591	center pad load "mybg.png"	747	center keep { pad load "mybg.png" }
592		748
593	=item rootalign $img	749	=item rootalign $img
594		750
595	Moves the image so that it appears glued to the screen as opposed to the	751	Moves the image so that it appears glued to the screen as opposed to the
596	window. This gives the illusion of a larger area behind the window. It is	752	window. This gives the illusion of a larger area behind the window. It is
597	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the	753	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
598	top left of the screen.	754	top left of the screen.
599		755
600	Example: load a background image, put it in mirror mode and root align it.	756	Example: load a background image, put it in mirror mode and root align it.
601		757
602	rootalign mirror load "mybg.png"	758	rootalign keep { mirror load "mybg.png" }
603		759
604	Example: take the screen background and align it, giving the illusion of	760	Example: take the screen background and align it, giving the illusion of
605	transparency as long as the window isn't in front of other windows.	761	transparency as long as the window isn't in front of other windows.
606		762
607	rootalign root	763	rootalign root
…		…
632		788
633	sub rootalign($) {	789	sub rootalign($) {
634	move -TX, -TY, $_[0]	790	move -TX, -TY, $_[0]
635	}	791	}
636		792
		793	=item rotate $center_x, $center_y, $degrees, $img
		794
		795	Rotates the image clockwise by C<$degrees> degrees, around the point at
		796	C<$center_x> and C<$center_y> (specified as factor of image width/height).
		797
		798	Example: rotate the image by 90 degrees around its center.
		799
		800	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
		801
		802	=cut
		803
		804	sub rotate($$$$) {
		805	my $img = pop;
		806	$img->rotate (
		807	$_[0] * ($img->w + $img->x),
		808	$_[1] * ($img->h + $img->y),
		809	$_[2] * (3.14159265 / 180),
		810	)
		811	}
		812
637	=back	813	=back
638		814
639	=head2 COLOUR MODIFICATIONS	815	=head2 COLOUR MODIFICATIONS
640		816
641	The following operators change the pixels of the image.	817	The following operators change the pixels of the image.
642		818
643	=over 4	819	=over 4
		820
		821	=item tint $color, $img
		822
		823	Tints the image in the given colour.
		824
		825	Example: tint the image red.
		826
		827	tint "red", load "rgb.png"
		828
		829	Example: the same, but specify the colour by component.
		830
		831	tint [1, 0, 0], load "rgb.png"
		832
		833	=cut
		834
		835	sub tint($$) {
		836	$_[1]->tint ($_[0])
		837	}
		838
		839	=item shade $factor, $img
		840
		841	Shade the image by the given factor.
		842
		843	=cut
		844
		845	sub shade($$) {
		846	$_[1]->shade ($_[0])
		847	}
644		848
645	=item contrast $factor, $img	849	=item contrast $factor, $img
646		850
647	=item contrast $r, $g, $b, $img	851	=item contrast $r, $g, $b, $img
648		852
…		…
675		879
676	Values less than 0 reduce brightness, while values larger than 0 increase	880	Values less than 0 reduce brightness, while values larger than 0 increase
677	it. Useful range is from -1 to 1 - the former results in a black, the	881	it. Useful range is from -1 to 1 - the former results in a black, the
678	latter in a white picture.	882	latter in a white picture.
679		883
680	Due to idiosynchrasies in the underlying XRender extension, biases less	884	Due to idiosyncrasies in the underlying XRender extension, biases less
681	than zero can be I<very> slow.	885	than zero can be I<very> slow.
		886
		887	You can also try the experimental(!) C<muladd> operator.
682		888
683	=cut	889	=cut
684		890
685	sub contrast($$;$$;$) {	891	sub contrast($$;$$;$) {
686	my $img = pop;	892	my $img = pop;
…		…
702	$a = 1 if @_ < 4;	908	$a = 1 if @_ < 4;
703		909
704	$img = $img->clone;	910	$img = $img->clone;
705	$img->brightness ($r, $g, $b, $a);	911	$img->brightness ($r, $g, $b, $a);
706	$img	912	$img
		913	}
		914
		915	=item muladd $mul, $add, $img # EXPERIMENTAL
		916
		917	First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used
		918	to implement brightness and contrast at the same time, with a wider value
		919	range than contrast and brightness operators.
		920
		921	Due to numerous bugs in XRender implementations, it can also introduce a
		922	number of visual artifacts.
		923
		924	Example: increase contrast by a factor of C<$c> without changing image
		925	brightness too much.
		926
		927	muladd $c, (1 - $c) * 0.5, $img
		928
		929	=cut
		930
		931	sub muladd($$$) {
		932	$_[2]->muladd ($_[0], $_[1])
707	}	933	}
708		934
709	=item blur $radius, $img	935	=item blur $radius, $img
710		936
711	=item blur $radius_horz, $radius_vert, $img	937	=item blur $radius_horz, $radius_vert, $img
…		…
723	sub blur($$;$) {	949	sub blur($$;$) {
724	my $img = pop;	950	my $img = pop;
725	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	951	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
726	}	952	}
727		953
728	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	954	=item focus_fade $img
729		955
730	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	956	=item focus_fade $factor, $img
731	pointer at C<$center_x> and C<$center_y> (specified as factor of image
732	width/height), generating a new image with width C<$new_width> and height
733	C<$new_height>.
734		957
735	#TODO# new width, height, maybe more operators?	958	=item focus_fade $factor, $color, $img
736		959
737	Example: rotate the image by 90 degrees	960	Fades the image by the given factor (and colour) when focus is lost (the
		961	same as the C<-fade>/C<-fadecolor> command line options, which also supply
		962	the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
		963	C<$factor> is a real value, not a percentage value (that is, 0..1, not
		964	0..100).
738		965
739	=cut	966	Example: do the right thing when focus fading is requested.
740		967
741	sub rotate($$$$$$) {	968	focus_fade load "mybg.jpg";
		969
		970	=cut
		971
		972	sub focus_fade($;$$) {
742	my $img = pop;	973	my $img = pop;
743	$img->rotate (	974
744	$_[0],	975	return $img
745	$_[1],	976	if FOCUS;
746	$_[2] * $img->w,	977
747	$_[3] * $img->h,	978	my $fade = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0;
748	$_[4] * (3.14159265 / 180),	979	my $color = @_ >= 2 ? $_[1] : $self->resource ("color+" . urxvt::Color_fade);
749	)	980
		981	$img = $img->tint ($color) if $color ne "rgb:00/00/00";
		982	$img = $img->muladd (1 - $fade, 0) if $fade;
		983
		984	$img
750	}	985	}
751		986
752	=back	987	=back
753		988
		989	=head2 OTHER STUFF
		990
		991	Anything that didn't fit any of the other categories, even after applying
		992	force and closing our eyes.
		993
		994	=over 4
		995
		996	=item keep { ... }
		997
		998	This operator takes a code block as argument, that is, one or more
		999	statements enclosed by braces.
		1000
		1001	The trick is that this code block is only evaluated when the outcome
		1002	changes - on other calls the C<keep> simply returns the image it computed
		1003	previously (yes, it should only be used with images). Or in other words,
		1004	C<keep> I<caches> the result of the code block so it doesn't need to be
		1005	computed again.
		1006
		1007	This can be extremely useful to avoid redoing slow operations - for
		1008	example, if your background expression takes the root background, blurs it
		1009	and then root-aligns it it would have to blur the root background on every
		1010	window move or resize.
		1011
		1012	Another example is C<load>, which can be quite slow.
		1013
		1014	In fact, urxvt itself encloses the whole expression in some kind of
		1015	C<keep> block so it only is reevaluated as required.
		1016
		1017	Putting the blur into a C<keep> block will make sure the blur is only done
		1018	once, while the C<rootalign> is still done each time the window moves.
		1019
		1020	rootalign keep { blur 10, root }
		1021
		1022	This leaves the question of how to force reevaluation of the block,
		1023	in case the root background changes: If expression inside the block
		1024	is sensitive to some event (root background changes, window geometry
		1025	changes), then it will be reevaluated automatically as needed.
		1026
		1027	=cut
		1028
		1029	sub keep(&) {
		1030	my $id = $_[0]+0;
		1031
		1032	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
		1033
		1034	unless ($frame->[FR_CACHE]) {
		1035	$frame->[FR_CACHE] = [ $_[0]() ];
		1036
		1037	my $self = $self;
		1038	my $frame = $frame;
		1039	Scalar::Util::weaken $frame;
		1040	$self->compile_frame ($frame, sub {
		1041	# clear this frame cache, also for all parents
		1042	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		1043	undef $frame->[FR_CACHE];
		1044	}
		1045
		1046	$self->recalculate;
		1047	});
		1048	};
		1049
		1050	# in scalar context we always return the first original result, which
		1051	# is not quite how perl works.
		1052	wantarray
		1053	? @{ $frame->[FR_CACHE] }
		1054	: $frame->[FR_CACHE][0]
		1055	}
		1056
		1057	# sub keep_clear() {
		1058	# delete $self->{frame_cache};
		1059	# }
		1060
		1061	=back
		1062
754	=cut	1063	=cut
755		1064
756	}	1065	}
757		1066
758	sub parse_expr {	1067	sub parse_expr {
759	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	1068	my $expr = eval
		1069	"sub {\n"
		1070	. "package urxvt::bgdsl;\n"
		1071	. "#line 0 'background expression'\n"
		1072	. "$_[0]\n"
		1073	. "}";
760	die if $@;	1074	die if $@;
761	$expr	1075	$expr
762	}	1076	}
763		1077
764	# compiles a parsed expression	1078	# compiles a parsed expression
765	sub set_expr {	1079	sub set_expr {
766	my ($self, $expr) = @_;	1080	my ($self, $expr) = @_;
767		1081
		1082	$self->{root} = []; # the outermost frame
768	$self->{expr} = $expr;	1083	$self->{expr} = $expr;
769	$self->recalculate;	1084	$self->recalculate;
		1085	}
		1086
		1087	# takes a hash of sensitivity indicators and installs watchers
		1088	sub compile_frame {
		1089	my ($self, $frame, $cb) = @_;
		1090
		1091	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		1092	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		1093
		1094	# don't keep stuff alive
		1095	Scalar::Util::weaken $state;
		1096
		1097	if ($again->{nested}) {
		1098	$state->{nested} = 1;
		1099	} else {
		1100	delete $state->{nested};
		1101	}
		1102
		1103	if (my $interval = $again->{time}) {
		1104	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		1105	if $state->{time}[0] != $interval;
		1106
		1107	# callback might have changed, although we could just rule that out
		1108	$state->{time}[1]->cb (sub {
		1109	++$state->{counter};
		1110	$cb->();
		1111	});
		1112	} else {
		1113	delete $state->{time};
		1114	}
		1115
		1116	if ($again->{position}) {
		1117	$state->{position} = $self->on (position_change => $cb);
		1118	} else {
		1119	delete $state->{position};
		1120	}
		1121
		1122	if ($again->{size}) {
		1123	$state->{size} = $self->on (size_change => $cb);
		1124	} else {
		1125	delete $state->{size};
		1126	}
		1127
		1128	if ($again->{rootpmap}) {
		1129	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		1130	} else {
		1131	delete $state->{rootpmap};
		1132	}
		1133
		1134	if ($again->{focus}) {
		1135	$state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
		1136	} else {
		1137	delete $state->{focus};
		1138	}
770	}	1139	}
771		1140
772	# evaluate the current bg expression	1141	# evaluate the current bg expression
773	sub recalculate {	1142	sub recalculate {
774	my ($arg_self) = @_;	1143	my ($arg_self) = @_;
…		…
784		1153
785	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1154	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
786		1155
787	# set environment to evaluate user expression	1156	# set environment to evaluate user expression
788		1157
789	local $self = $arg_self;	1158	local $self = $arg_self;
790
791	local $HOME = $ENV{HOME};	1159	local $HOME = $ENV{HOME};
792	local $old = $self->{state};	1160	local $frame = $self->{root};
793	local $new = my $state = $self->{state} = {};
794		1161
795	($x, $y, $w, $h) =
796	$self->background_geometry ($self->{border});	1162	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
		1163	$focus = $self->focus;
797		1164
798	# evaluate user expression	1165	# evaluate user expression
799		1166
800	my $img = eval { $self->{expr}->() };	1167	my @img = eval { $self->{expr}->() };
801	warn $@ if $@;#d#	1168	die $@ if $@;
802	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	1169	die "background-expr did not return anything.\n" unless @img;
		1170	die "background-expr: expected image(s), got something else.\n"
		1171	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
803		1172
804	$state->{size_sensitive} = 1	1173	my $img = urxvt::bgdsl::merge @img;
		1174
		1175	$frame->[FR_AGAIN]{size} = 1
805	if $img->repeat_mode != urxvt::RepeatNormal;	1176	if $img->repeat_mode != urxvt::RepeatNormal;
806		1177
807	# if the expression is sensitive to external events, prepare reevaluation then	1178	# if the expression is sensitive to external events, prepare reevaluation then
808		1179	$self->compile_frame ($frame, sub { $arg_self->recalculate });
809	my $repeat;
810
811	if (my $again = $state->{again}) {
812	$repeat = 1;
813	my $self = $self;
814	$state->{timer} = $again == $old->{again}
815	? $old->{timer}
816	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
817	++$self->{counter};
818	$self->recalculate
819	});
820	}
821
822	if (delete $state->{position_sensitive}) {
823	$repeat = 1;
824	$self->enable (position_change => sub { $_[0]->recalculate });
825	} else {
826	$self->disable ("position_change");
827	}
828
829	if (delete $state->{size_sensitive}) {
830	$repeat = 1;
831	$self->enable (size_change => sub { $_[0]->recalculate });
832	} else {
833	$self->disable ("size_change");
834	}
835
836	if (delete $state->{rootpmap_sensitive}) {
837	$repeat = 1;
838	$self->enable (rootpmap_change => sub { $_[0]->recalculate });
839	} else {
840	$self->disable ("rootpmap_change");
841	}
842		1180
843	# clear stuff we no longer need	1181	# clear stuff we no longer need
844		1182
845	%$old = ();	1183	# unless (%{ $frame->[FR_STATE] }) {
846
847	unless ($repeat) {
848	delete $self->{state};	1184	# delete $self->{state};
849	delete $self->{expr};	1185	# delete $self->{expr};
850	}	1186	# }
851		1187
852	# set background pixmap	1188	# set background pixmap
853		1189
854	$self->set_background ($img, $self->{border});	1190	$self->set_background ($img, $self->{border});
855	$self->scr_recolour (0);	1191	$self->scr_recolor (0);
856	$self->want_refresh;	1192	$self->want_refresh;
857	}	1193	}
858		1194
859	sub on_start {	1195	sub on_start {
860	my ($self) = @_;	1196	my ($self) = @_;

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.49 by root, Sun Jun 10 15:29:18 2012 UTC vs. Revision 1.89 by root, Sat Dec 13 12:24:33 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.49 by root, Sun Jun 10 15:29:18 2012 UTC vs.
Revision 1.89 by root, Sat Dec 13 12:24:33 2014 UTC