git.hungrycats.org Git - xscreensaver/blob - hacks/blitspin.man

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