c61f7a6025bbee171b958330fda15c6e7b2f5916
[xscreensaver] / hacks / glx / mirrorblob.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 mirrorblob - Draws a wobbly blob that distorts the image behind it.
4 .SH SYNOPSIS
5 .B mirrorblob
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-wire]
11 [\-delay \fInumber\fP]
12 [\-fog]
13 [\-walls]
14 [\-colour]
15 [\-texture]
16 [\-offset-texture]
17 [\-blend]
18 [\-antialias]
19 [\-resolution \fInumber\fP]
20 [\-bumps \fInumber\fP]
21 [\-fade-time \fInumber\fP]
22 [\-hold-time \fInumber\fP]
23 [\-zoom \fInumber\fP]
24 [\-fps]
25 .SH DESCRIPTION
26 Draws a wobbling blob, making use of alpha blending, fog,
27 textures, and lighting, plus a ``frames per second'' meter so that you can
28 tell how fast your graphics card is... Requires OpenGL.
29 .SH OPTIONS
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 \-window
36 Draw on a newly-created window.  This is the default.
37 .TP 8
38 .B \-root
39 Draw on the root window.
40 .B \-wire
41 Render in wireframe instead of solid.
42 .TP 8
43 .B \-delay \fInumber\fP
44 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
45 .TP 8
46 .B \-fog | \-no-fog
47 Whether to enable fog.
48 .TP 8
49 .B \-walls | \-no-walls
50 Add walls for blob to hit.
51 .TP 8
52 .B \-colour | \-no-colour
53 Draw coloured blob.  If also textured, the texture will have color mixed in.
54 .TP 8
55 .B \-texture | \-no-texture
56 Whether to wrap a texture image on the blob.
57 .TP 8
58 .B \-offset_texture | \-no-offset_texture
59 Whether to ofset the texture calculations to only use a region of the image
60  under the blob.  This works well with a semi-transparent blob.
61 .TP 8
62 .B \-blend | \-no-blend
63 Whether to draw a transparent blob. (see also offset_texture above)
64 .TP 8
65 .B \-antialias | \-no-antialias
66 Whether to antialias lines.
67 .TP 8
68 .B \-resolution \fInumber\fP
69 Resolution of the tessellation used to calculate and draw the blob.  Larger
70  numbers give a smoother blob but increase calculation times exponentially.
71 .TP 8
72 .B \-bumps \fInumber\fP
73 Number of bumps used to distort the blob.
74 .TP 8
75 .B \-hold-time \fInumber\fP
76 Time until loading a new image.
77 .TP 8
78 .B \-fade-time \fInumber\fP
79 Time taken to transition between images.
80 .TP 8
81 .B \-zoom \fInumber\fP
82 Size multiplier for blob.
83 .TP 8
84 .B \-fps
85 Display the current frame rate, CPU load, and polygon count.
86 .SH ENVIRONMENT
87 .PP
88 .TP 8
89 .B DISPLAY
90 to get the default host and display number.
91 .TP 8
92 .B XENVIRONMENT
93 to get the name of a resource file that overrides the global resources
94 stored in the RESOURCE_MANAGER property.
95 .SH SEE ALSO
96 .BR X (1),
97 .BR xscreensaver (1)
98 .SH COPYRIGHT
99 Copyright \(co 2003 by Jon Dowdall.  Permission to use, copy, modify, 
100 distribute, and sell this software and its documentation for any purpose is 
101 hereby granted without fee, provided that the above copyright notice appear 
102 in all copies and that both that copyright notice and this permission notice
103 appear in supporting documentation.  No representations are made about the 
104 suitability of this software for any purpose.  It is provided "as is" without
105 express or implied warranty.
106 .SH AUTHOR
107 Jon Dowdall.