git.hungrycats.org Git - xscreensaver/blob - hacks/glx/voronoi.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 voronoi - draws a randomly-colored Voronoi tessellation
   4 .SH SYNOPSIS
   5 .B voronoi
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-points \fIint\fP]
  11 [\-point\-size \fIint\fP]
  12 [\-point\-speed \fIratio\fP]
  13 [\-point\-delay \fIseconds\fP]
  14 [\-zoom\-speed \fIratio\fP]
  15 [\-zoom\-delay \fIseconds\fP]
  16 [\-fps]
  17 .SH DESCRIPTION
  18 Draws a randomly-colored Voronoi tessellation, and periodically zooms
  19 in and adds new points.  The existing points also wander around.
  20
  21 There are a set of control points on the plane, each at the center of
  22 a colored cell.  Every pixel within that cell is closer to that cell's
  23 control point than to any other control point.  That is what
  24 determines the cell's shapes.
  25
  26 When running in a window, you can click  to insert a new point at
  27 the mouse position.  Clicking on an existing point lets you drag
  28 it around.
  29
  30 This implementation takes advantage of the OpenGL depth buffer to
  31 compute the cells for us, by rendering the intersection of overlapping
  32 cones in an orthographic plane.
  33 .SH OPTIONS
  34 .TP 8
  35 .B \-visual \fIvisual\fP
  36 Specify which visual to use.  Legal values are the name of a visual class,
  37 or the id number (decimal or hex) of a specific visual.
  38 .TP 8
  39 .B \-window
  40 Draw on a newly-created window.  This is the default.
  41 .TP 8
  42 .B \-root
  43 Draw on the root window.
  44 .TP 8
  45 .B \-points \fIint\fP
  46 How many points to add each time we zoom in.
  47 .TP 8
  48 .B \-point\-size \fIint\fP
  49 How big to draw the stars, in pixels.  0 for no stars.
  50 .TP 8
  51 .B \-point\-speed \fIratio\fP
  52 How fast the points should wander.
  53 Less than 1 for slower, greater than 1 for faster.
  54 .TP 8
  55 .B \-point\-delay \fIseconds\fP
  56 How quickly to insert new points, when adding.
  57 .TP 8
  58 .B \-zoom\-speed \fIratio\fP
  59 How fast to zoom in.
  60 Less than 1 for slower, greater than 1 for faster.
  61 .TP 8
  62 .B \-zoom\-delay \fIseconds\fP
  63 Zoom in every this-many seconds.
  64 .TP 8
  65 .B \-fps
  66 Display the current frame rate, CPU load, and polygon count.
  67 .SH ENVIRONMENT
  68 .PP
  69 .TP 8
  70 .B DISPLAY
  71 to get the default host and display number.
  72 .TP 8
  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 .SH COPYRIGHT
  80 Copyright \(co 2007 by Jamie Zawinski.  Permission to use, copy, modify,
  81 distribute, and sell this software and its documentation for any purpose is
  82 hereby granted without fee, provided that the above copyright notice appear
  83 in all copies and that both that copyright notice and this permission notice
  84 appear in supporting documentation.  No representations are made about the
  85 suitability of this software for any purpose.  It is provided "as is" without
  86 express or implied warranty.
  87 .SH AUTHOR
  88 Jamie Zawinski.