git.hungrycats.org Git - xscreensaver/blob - 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 [\-bgimage]
  17 [\-offset_texture]
  18 [\-blend]
  19 [\-antialias]
  20 [\-x_res \fInumber\fP]
  21 [\-y_res \fInumber\fP]
  22 [\-field_points \fInumber\fP]
  23 [\-hold_frames \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 \-bgimage | \-no-bgimage
  59 Whether to also draw the texture on the background.
  60 .TP 8
  61 .B \-offset_texture | \-no-offset_texture
  62 Whether to ofset the texture calculations to only use a region of the image
  63  under the blob.  This works well when blend is enabled.
  64 .TP 8
  65 .B \-blend | \-no-blend
  66 Whether to enable blending. (see also offset_texture above)
  67 .TP 8
  68 .B \-antialias | \-no-antialias
  69 Whether to anti-alias lines.
  70 .TP 8
  71 .B \-x_res \fInumber\fP
  72 Number of verticies around the middle row of the blob (see also y_res).
  73 .TP 8
  74 .B \-y_res \fInumber\fP
  75 Number of rows of verticies used to calculatethe blob, combined with x_res to
  76  indirectly determine the number of triangles used to draw blob.  Larger
  77  numbers give a smoother blob but increase calculation times exponentially.
  78 .TP 8
  79 .B \-field_points \fInumber\fP
  80 Number of points used to distort the blob.
  81 .TP 8
  82 .B \-hold_frames \fInumber\fP
  83 Number of frames between changing images.
  84 .TP 8
  85 .B \-fade_speed \fInumber\fP
  86 Speed at which fading occurs when changing images.
  87 .TP 8
  88 .B \-fps | \-no-fps
  89 Whether to show a frames-per-second display at the bottom of the screen.
  90 .SH ENVIRONMENT
  91 .PP
  92 .TP 8
  93 .B DISPLAY
  94 to get the default host and display number.
  95 .TP 8
  96 .B XENVIRONMENT
  97 to get the name of a resource file that overrides the global resources
  98 stored in the RESOURCE_MANAGER property.
  99 .SH SEE ALSO
 100 .BR X (1),
 101 .BR xscreensaver (1)
 102 .SH COPYRIGHT
 103 Copyright \(co 2003 by Jon Dowdall.  Permission to use, copy, modify,
 104 distribute, and sell this software and its documentation for any purpose is
 105 hereby granted without fee, provided that the above copyright notice appear
 106 in all copies and that both that copyright notice and this permission notice
 107 appear in supporting documentation.  No representations are made about the
 108 suitability of this software for any purpose.  It is provided "as is" without
 109 express or implied warranty.
 110 .SH AUTHOR
 111 Jon Dowdall.