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

   1 .de EX          \"Begin example
   2 .ne 5
   3 .if n .sp 1
   4 .if t .sp .5
   5 .nf
   6 .in +.5i
   7 ..
   8 .de EE
   9 .fi
  10 .in -.5i
  11 .if n .sp 1
  12 .if t .sp .5
  13 ..
  14 .TH XScreenSaver 1 "18-May-2002" "X Version 11"
  15 .SH NAME
  16 lavalite - 3D OpenGL simulation of a Lavalite.
  17 .SH SYNOPSIS
  18 .B lavalite
  19 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
  20 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
  21 [\-style \fIstyle\fP ]
  22 [\-spin \fIxyz\fP ] [\-no-spin ]
  23 [\-speed \fIfloat\fP ]
  24 [\-resolution \fIinteger\fP ]
  25 [\-count \fIinteger\fP ]
  26 [\-no-smooth ]
  27 [\-wireframe ]
  28 [\-impatient ]
  29 [\-lava-color \fIcolor\fP ]
  30 [\-fluid-color \fIcolor\fP ]
  31 [\-base-color \fIcolor\fP ]
  32 [\-table-color \fIcolor\fP ]
  33 [\-fluid-texture \fIfilename\fP ]
  34 [\-base-texture \fIfilename\fP ]
  35 [\-table-texture \fIfilename\fP ]
  36 .SH DESCRIPTION
  37 The \fIlavalite\fP program displays a 3D simulation of the famous lamp
  38 of the same name.  It requires a fast computer with fast OpenGL support.
  39 .SH OPTIONS
  40 .I lavalite
  41 accepts the following options:
  42 .TP 8
  43 .B \-window
  44 Draw on a newly-created window.  This is the default.
  45 .TP 8
  46 .B \-root
  47 Draw on the root window.
  48 .TP 8
  49 .B \-visual \fIvisual\fP\fP
  50 Specify which visual to use.  Legal values are the name of a visual class,
  51 or the id number (decimal or hex) of a specific visual.
  52 .TP 8
  53 .B \-style \fIstyle\fP\fP
  54 Specify which model of lamp to draw.  Available models
  55 are: \fBClassic\fP, \fBGiant\fP, \fBCone\fP, and \fBRocket\fP.
  56 Default: random.
  57 .TP 8
  58 .B \-spin \fIxyz\fP
  59 Around which axes the model should auto-spin.  Defaults to "Z", meaning
  60 it rotates horizontally, but otherwise pitch or roll.
  61 .TP 8
  62 .B \-no-spin
  63 Same as \fB\-spin ''\fP.
  64 .TP 8
  65 .B \-speed \fIfloat\fP
  66 A number controlling the frequency at which new blobs launch: you can
  67 think of this as being related to the the heat of the lightbulb in
  68 the base.  Default: 0.003.
  69 .TP 8
  70 .B \-delay \fIusecs\fP
  71 The delay between steps of the animation; default is 40000 (1/25th second.)
  72 .TP 8
  73 .B \-resolution \fIinteger\fP
  74 The size of the grid from which the mesh is created that is used
  75 to polygonize the blobs.  higher values will give very smooth looking
  76 blobs, at the expense of speed.  Default: 40.
  77
  78 The options "-resolution 10 -no-smooth" look kind of interesting.
  79 .TP 8
  80 .B \-fps
  81 Display a running tally of how many frames per second are being rendered.
  82 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
  83 your GL performance.
  84 .TP 8
  85 .B \-count \fIinteger\fP
  86 The maximum number of blobs that can be in motion at once.
  87 Default: 3.
  88 .TP 8
  89 .B \-no-smooth
  90 Turn off smoothing: the objects in the scene will be facetted.
  91 .TP 8
  92 .B \-wireframe
  93 Render all objects in wireframe instead of as solids.
  94 .TP 8
  95 .B \-impatient
  96 Provide this option if you are.  This will pre-warm the lamp, so when it
  97 starts up, the first frame will show a blob already halfway up the lamp.
  98 .TP 8
  99 .B \-lava-color \fIcolor\fP
 100 Specifies the color of the blobbies.  Default: red.
 101 .TP 8
 102 .B \-fluid-color \fIcolor\fP
 103 Specifies the color of the fluid that the blobbies float in.
 104 Default: light blue.
 105 .TP 8
 106 .B \-base-color \fIcolor\fP
 107 Specifies the color of the lamp base, and the cap on top of the bottle.
 108 Default: very dark gray.
 109 .TP 8
 110 .B \-table-color \fIcolor\fP
 111 Specifies the color of the table that the lamp is sitting on.
 112 Default: black (meaning it is invisible.)
 113 .TP 8
 114 .B \-fluid-texture \fIfilename\fP
 115 An image file to wrap around the glass.
 116
 117 Note that on most systems, GL textures must have dimensions that are a
 118 power of two.
 119
 120 Note also that colors and textures are both applied: so, if you apply a
 121 texture and it isn't showing up, try specifying the corresponding color
 122 as "white".  Otherwise, the combination of the two might be too dark to
 123 see.
 124 .TP 8
 125 .B \-base-texture \fIfilename\fP
 126 An image file to wrap around the base of the lamp, and the cap on top
 127 of the bottle.
 128 .TP 8
 129 .B \-table-texture \fItexture\fP
 130 An image file to spread across the table that the lamp is sitting on.
 131 .SH ENVIRONMENT
 132 .PP
 133 .TP 8
 134 .B DISPLAY
 135 to get the default host and display number.
 136 .TP 8
 137 .B XENVIRONMENT
 138 to get the name of a resource file that overrides the global resources
 139 stored in the RESOURCE_MANAGER property.
 140 .SH SEE ALSO
 141 .BR X (1),
 142 .BR xscreensaver (1),
 143  http://www.lavaworld.com/
 144  http://www.lavarnd.org/
 145 .SH COPYRIGHT
 146 Copyright \(co 2002 by Jamie Zawinski.
 147 Permission to use, copy, modify, distribute, and sell this software and
 148 its documentation for any purpose is hereby granted without fee,
 149 provided that the above copyright notice appear in all copies and that
 150 both that copyright notice and this permission notice appear in
 151 supporting documentation.  No representations are made about the
 152 suitability of this software for any purpose.  It is provided "as is"
 153 without express or implied warranty.
 154
 155 LAVA LITE\(rg and the configuration of the LAVA\(rg brand motion lamp
 156 are registered trademarks of Haggerty Enterprises, Inc.  The
 157 configuration of the globe and base of the motion lamp are registered
 158 trademarks of Haggerty Enterprises, Inc. in the U.S.A. and in other
 159 countries around the world.
 160
 161 .SH AUTHOR
 162 Jamie Zawinski <jwz@jwz.org>