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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 hilbert - 3D Hilbert fractal.
   4 .SH SYNOPSIS
   5 .B hilbert
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-delay \fInumber\fP]
  11 [\-speed \fIratio\fP]
  12 [\-depth \fInumber\fP]
  13 [\-spin]
  14 [\-wander]
  15 [\-2d]
  16 [\-3d]
  17 [\-closed]
  18 [\-open]
  19 [\-max\-depth \fInumber\fP]
  20 [\-thickness \fIratio\fP]
  21 [\-wireframe]
  22 [\-fps]
  23 .SH DESCRIPTION
  24 This draws the recursive Hilbert space-filling curve, in both 2D and
  25 3D variants.  It incrementally animates the growth and recursion to
  26 the maximum depth, then unwinds it back.
  27
  28 The Hilbert path is a single contiguous line that can fill a volume
  29 without crossing itself.  As a data structure, Hilbert paths are
  30 useful because ordering along the curve preserves locality: points
  31 that close together along the curve are also close together in space.
  32 The converse is often, but not always, true.  The coloration
  33 reflects this.
  34 .SH OPTIONS
  35 .TP 8
  36 .B \-visual \fIvisual\fP
  37 Specify which visual to use.  Legal values are the name of a visual class,
  38 or the id number (decimal or hex) of a specific visual.
  39 .TP 8
  40 .B \-window
  41 Draw on a newly-created window.  This is the default.
  42 .TP 8
  43 .B \-root
  44 Draw on the root window.
  45 .TP 8
  46 .B \-delay \fInumber\fP
  47 Per-frame delay, in microseconds.  Default: 30000 (0.03 seconds.).
  48 .TP 8
  49 .B \-speed \fInumber\fP
  50 How fast the animation should run.
  51 Less than 1 for slower, greater than 1 for faster.
  52 .TP 8
  53 .B \-max\-depth \fInumber\fP
  54 Max depth to descend.  Default: 5, which peaks at around half a
  55 million polygons.
  56 .TP 8
  57 .B \-spin
  58 .B \-no\-spin
  59 Whether to rotate the object.  Default: true.
  60 .TP 8
  61 .B \-wander
  62 .B \-no\-wander
  63 Whether to wander the object around on the screen.  Default: false;
  64 .TP 8
  65 .B \-2d
  66 .B \-3d
  67 Whether to draw the 2D or 3D variant. Default: random.
  68 .TP 8
  69 .B \-closed
  70 .B \-open
  71 Whether to draw the open or closed-path variant. Default: random.
  72 .TP 8
  73 .B \-thickness \fIratio\fP
  74 How thick the lines should be.  Default: 0.25.
  75 .TP 8
  76 .B \-wireframe
  77 Render in wireframe instead of solid.
  78 .TP 8
  79 .B \-fps
  80 Display the current frame rate, CPU load, and polygon count.
  81 .SH ENVIRONMENT
  82 .PP
  83 .TP 8
  84 .B DISPLAY
  85 to get the default host and display number.
  86 .TP 8
  87 .B XENVIRONMENT
  88 to get the name of a resource file that overrides the global resources
  89 stored in the RESOURCE_MANAGER property.
  90 .SH SEE ALSO
  91 .BR X (1),
  92 .BR xscreensaver (1)
  93 .SH COPYRIGHT
  94 Copyright \(co 2011 by Jamie Zawinski.  Permission to use, copy,
  95 modify, distribute, and sell this software and its documentation for
  96 any purpose is hereby granted without fee, provided that the above
  97 copyright notice appear in all copies and that both that copyright
  98 notice and this permission notice appear in supporting documentation.
  99 No representations are made about the suitability of this software for
 100 any purpose.  It is provided "as is" without express or implied
 101 warranty.
 102 .SH AUTHOR
 103 Jamie Zawinski.