3ad07641f60b8d12805d3c522afdc25d699c0e00
[xscreensaver] / hacks / glx / glblur.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 glblur - 3D radial blur texture fields
4 .SH SYNOPSIS
5 .B menger
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-blursize \fInumber\fP]
12 [\-no-wander]
13 [\-no-spin]
14 [\-spin \fI[XYZ]\fP]
15 [\-wireframe]
16 [\-fps]
17 .SH DESCRIPTION
18 This program draws a box and a few line segments, and generates a 
19 radial blur outward from it.  This creates flowing field effects.
20
21 This is done by rendering the scene into a small texture, then
22 repeatedly rendering increasingly-enlarged and increasingly-transparent
23 versions of that texture onto the frame buffer.  As such, it's quite
24 graphics intensive: don't bother trying to run this if you don't have
25 hardware-accelerated texture support.  It will hurt your machine bad.
26 .SH OPTIONS
27 .TP 8
28 .B \-visual \fIvisual\fP
29 Specify which visual to use.  Legal values are the name of a visual class,
30 or the id number (decimal or hex) of a specific visual.
31 .TP 8
32 .B \-window
33 Draw on a newly-created window.  This is the default.
34 .TP 8
35 .B \-root
36 Draw on the root window.
37 .TP 8
38 .B \-delay \fInumber\fP
39 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
40 .TP 8
41 .B \-blursize \fInumber\fP
42 How many copies of the scene should be laid down to make the vapor trail.
43 Default: 15.  Larger numbers create smoother fields, but are slower.
44 .TP 8
45 .B \-wander | \-no-wander
46 Whether the object should wander around the screen.
47 .TP 8
48 .B \-spin [XYZ]
49 Around which axes should the object spin?
50 .TP 8
51 .B \-no-spin
52 None.
53 .TP 8
54 .B \-wireframe
55 Render in wireframe instead of solid.
56 .TP 8
57 .B \-fps | \-no-fps
58 Whether to show a frames-per-second display at the bottom of the screen.
59 .SH ENVIRONMENT
60 .PP
61 .TP 8
62 .B DISPLAY
63 to get the default host and display number.
64 .TP 8
65 .B XENVIRONMENT
66 to get the name of a resource file that overrides the global resources
67 stored in the RESOURCE_MANAGER property.
68 .SH SEE ALSO
69 .BR X (1),
70 .BR xscreensaver (1)
71 .SH COPYRIGHT
72 Copyright \(co 2002 by Jamie Zawinski.  Permission to use, copy, modify, 
73 distribute, and sell this software and its documentation for any purpose is 
74 hereby granted without fee, provided that the above copyright notice appear 
75 in all copies and that both that copyright notice and this permission notice
76 appear in supporting documentation.  No representations are made about the 
77 suitability of this software for any purpose.  It is provided "as is" without
78 express or implied warranty.
79 .SH AUTHOR
80 Jamie Zawinski, with inspiration from a tutorial by Dario Corno.