ftp://ftp.sunet.se/pub/vendor/sco/skunkware/osr5/x11/savers/xscreensaver/xscreensaver...
[xscreensaver] / local / man / man.1 / blitspin.1
1 .TH XScreenSaver 1 "16-May-97" "X Version 11"
2 .SH NAME
3 blitspin - rotate a bitmap in an interesting way
4 .SH SYNOPSIS
5 .B blitspin
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-bitmap \fIfilename\fP] [\-delay \fIusecs\fP] [\-delay2 \fIusecs\fP]
7 .SH DESCRIPTION
8 The \fIblitspin\fP program repeatedly rotates a bitmap by 90 degrees by
9 using logical operations: the bitmap is divided into quadrants, and the
10 quadrants are shifted clockwise.  Then the same thing is done again with
11 progressively smaller quadrants, except that all sub-quadrants of a 
12 given size are rotated in parallel.  So this takes \fBO(16*log2(N))\fP 
13 blits of size NxN, with the limitation that the image must be square,
14 and the size must be a power of 2.
15 .SH OPTIONS
16 .I blitspin
17 accepts the following options:
18 .TP 8
19 .B \-window
20 Draw on a newly-created window.  This is the default.
21 .TP 8
22 .B \-root
23 Draw on the root window.
24 .TP 8
25 .B \-mono 
26 If on a color display, pretend we're on a monochrome display.
27 .TP 8
28 .B \-install
29 Install a private colormap for the window.
30 .TP 8
31 .B \-visual \fIvisual\fP
32 Specify which visual to use.  Legal values are the name of a visual class,
33 or the id number (decimal or hex) of a specific visual.
34 .TP 8
35 .B \-bitmap \fIfilename\fP
36 The file name of a bitmap to rotate.  It need not be square: it 
37 will be padded with the background color.  If unspecified or the
38 string \fI(default)\fP, a builtin bitmap is used.
39
40 If support for the \fIXPM\fP library was enabled at compile-time, 
41 the specified file may be in \fIXPM\fP format as well as \fIXBM\fP, and 
42 thus may be a color image.
43
44 The \fB*bitmapFilePath\fP resource will be searched if the bitmap
45 name is not a fully-qualified pathname.
46 .TP 8
47 .B \-grab\-screen
48 If this option is specified, then the image which is spun will be grabbed
49 from the portion of the screen underlying the blitspin window.
50 .PP
51 .TP 8
52 .B \-delay microseconds
53 How long to delay between steps of the rotation process, in microseconds.
54 Default is 500000, one-half second.
55 .PP
56 .TP 8
57 .B \-delay2 microseconds
58 How long to delay between each 90-degree rotation, in microseconds.
59 Default is 500000, one-half second.
60 .B DISPLAY
61 to get the default host and display number.
62 .SH ENVIRONMENT
63 .B XENVIRONMENT
64 to get the name of a resource file that overrides the global resources
65 stored in the RESOURCE_MANAGER property.
66 .SH SEE ALSO
67 .BR X (1),
68 .BR xscreensaver (1)
69 .SH COPYRIGHT
70 Copyright \(co 1992, 1993, 1997 by Jamie Zawinski.
71 Permission to use, copy, modify, distribute, and sell this software and its
72 documentation for any purpose is hereby granted without fee, provided that
73 the above copyright notice appear in all copies and that both that copyright
74 notice and this permission notice appear in supporting documentation.  No
75 representations are made about the suitability of this software for any
76 purpose.  It is provided "as is" without express or implied warranty.
77 .SH AUTHOR
78 Jamie Zawinski <jwz@netscape.com>, 17-aug-92.
79
80 Based on SmallTalk code which appeared in the August 1981 issue of Byte
81 magazine.