X-Git-Url: http://git.hungrycats.org/cgi-bin/gitweb.cgi?p=xscreensaver;a=blobdiff_plain;f=hacks%2Fglx%2Fmirrorblob.man;fp=hacks%2Fglx%2Fmirrorblob.man;h=c61f7a6025bbee171b958330fda15c6e7b2f5916;hp=0000000000000000000000000000000000000000;hb=ffcd2e7e3da122dbba5c4188e05d3a63d0ede26e;hpb=019de959b265701cd0c3fccbb61f2b69f06bf9ee diff --git a/hacks/glx/mirrorblob.man b/hacks/glx/mirrorblob.man new file mode 100644 index 00000000..c61f7a60 --- /dev/null +++ b/hacks/glx/mirrorblob.man @@ -0,0 +1,107 @@ +.TH XScreenSaver 1 "" "X Version 11" +.SH NAME +mirrorblob - Draws a wobbly blob that distorts the image behind it. +.SH SYNOPSIS +.B mirrorblob +[\-display \fIhost:display.screen\fP] +[\-visual \fIvisual\fP] +[\-window] +[\-root] +[\-wire] +[\-delay \fInumber\fP] +[\-fog] +[\-walls] +[\-colour] +[\-texture] +[\-offset-texture] +[\-blend] +[\-antialias] +[\-resolution \fInumber\fP] +[\-bumps \fInumber\fP] +[\-fade-time \fInumber\fP] +[\-hold-time \fInumber\fP] +[\-zoom \fInumber\fP] +[\-fps] +.SH DESCRIPTION +Draws a wobbling blob, making use of alpha blending, fog, +textures, and lighting, plus a ``frames per second'' meter so that you can +tell how fast your graphics card is... Requires OpenGL. +.SH OPTIONS +.TP 8 +.B \-visual \fIvisual\fP +Specify which visual to use. Legal values are the name of a visual class, +or the id number (decimal or hex) of a specific visual. +.TP 8 +.B \-window +Draw on a newly-created window. This is the default. +.TP 8 +.B \-root +Draw on the root window. +.B \-wire +Render in wireframe instead of solid. +.TP 8 +.B \-delay \fInumber\fP +Per-frame delay, in microseconds. Default: 10000 (0.01 seconds.). +.TP 8 +.B \-fog | \-no-fog +Whether to enable fog. +.TP 8 +.B \-walls | \-no-walls +Add walls for blob to hit. +.TP 8 +.B \-colour | \-no-colour +Draw coloured blob. If also textured, the texture will have color mixed in. +.TP 8 +.B \-texture | \-no-texture +Whether to wrap a texture image on the blob. +.TP 8 +.B \-offset_texture | \-no-offset_texture +Whether to ofset the texture calculations to only use a region of the image + under the blob. This works well with a semi-transparent blob. +.TP 8 +.B \-blend | \-no-blend +Whether to draw a transparent blob. (see also offset_texture above) +.TP 8 +.B \-antialias | \-no-antialias +Whether to antialias lines. +.TP 8 +.B \-resolution \fInumber\fP +Resolution of the tessellation used to calculate and draw the blob. Larger + numbers give a smoother blob but increase calculation times exponentially. +.TP 8 +.B \-bumps \fInumber\fP +Number of bumps used to distort the blob. +.TP 8 +.B \-hold-time \fInumber\fP +Time until loading a new image. +.TP 8 +.B \-fade-time \fInumber\fP +Time taken to transition between images. +.TP 8 +.B \-zoom \fInumber\fP +Size multiplier for blob. +.TP 8 +.B \-fps +Display the current frame rate, CPU load, and polygon count. +.SH ENVIRONMENT +.PP +.TP 8 +.B DISPLAY +to get the default host and display number. +.TP 8 +.B XENVIRONMENT +to get the name of a resource file that overrides the global resources +stored in the RESOURCE_MANAGER property. +.SH SEE ALSO +.BR X (1), +.BR xscreensaver (1) +.SH COPYRIGHT +Copyright \(co 2003 by Jon Dowdall. Permission to use, copy, modify, +distribute, and sell this software and its documentation for any purpose is +hereby granted without fee, provided that the above copyright notice appear +in all copies and that both that copyright notice and this permission notice +appear in supporting documentation. No representations are made about the +suitability of this software for any purpose. It is provided "as is" without +express or implied warranty. +.SH AUTHOR +Jon Dowdall.