git.hungrycats.org Git - xscreensaver/blob - hacks/glx/glforestfire.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 "03-Oct-01" "X Version 11"
  15 .SH NAME
  16 glforestfire - draws a GL animation of sprinkling fire-like 3D triangles
  17 .SH SYNOPSIS
  18 .B glforestfire
  19 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
  20 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
  21 [\-count \fInumber_of_particles\fP]
  22 [\-trees \fInumber_of_trees\fP]
  23 [\-size \fIviewport_size\fP]
  24 [\-texture] [\-no-texture]
  25 [\-shadows] [\-no-shadows]
  26 [\-fog] [\-no-fog]
  27 [\-wireframe] [\-no-wireframe]
  28 [\-wander] [\-no-wander]
  29 [\-trackmouse] [\-no-trackmouse]
  30 [\-fps]
  31 .SH DESCRIPTION
  32 The \fIglforestfire\fP program draws an animation of sprinkling fire-like 3D triangles in
  33 a landscape filled with trees.
  34 .SH OPTIONS
  35 .I glforestfire
  36 accepts the following options:
  37 .TP 8
  38 .B \-window
  39 Draw on a newly-created window.  This is the default.
  40 .TP 8
  41 .B \-root
  42 Draw on the root window.
  43 .TP 8
  44 .B \-install
  45 Install a private colormap for the window.
  46 .TP 8
  47 .B \-visual \fIvisual\fP\fP
  48 Specify which visual to use.  Legal values are the name of a visual class,
  49 or the id number (decimal or hex) of a specific visual.
  50 .TP 8
  51 .B \-fps
  52 Display the current frame rate, CPU load, and polygon count.
  53 .TP 8
  54 .B \-trees \fInumber_of_trees\fP\fP
  55 Specify how much trees are drawn in the landscape.
  56 .TP 8
  57 .B \-count \fInumber_of_particles\fP\fP
  58 Specify how much fire particles are drawn. A very special case is 0
  59 wich means that you get
  60 .B rain
  61 !
  62 .TP 8
  63 .B \-size \fIviewport_size\fP\fP
  64 Viewport of GL scene is specified size if greater than 32 and less than screensize. Default value is 0, meaning full screensize.
  65 .TP 8
  66 .B \-texture
  67 Show a textured ground and the trees. This is the default.
  68 .TP 8
  69 .B \-no\-texture
  70 Disables texturing the landscape. This implies that no trees are drawn.
  71 .TP 8
  72 .B \-shadows
  73 Show a shadow for each particle on the ground. This is the default.
  74 .TP 8
  75 .B \-no\-shadows
  76 Disables the drawing of the shadows.
  77 .TP 8
  78 .B \-fog
  79 Show a fog in the distance.
  80 .TP 8
  81 .B \-no\-fog
  82 Disables the fog. This is the default.
  83 .TP 8
  84 .B \-wander
  85 Move the observer around the landscape. This is the default.
  86 .TP 8
  87 .B \-no\-wander
  88 Keep the fire centered on the screen.
  89 .TP 8
  90 .B \-trackmouse
  91 Let the mouse be a joystick to change the view of the landscape.
  92 This implies
  93 .I \-no\-wander.
  94 .TP 8
  95 .B \-no\-trackmouse
  96 Disables mouse tracking. This is the default.
  97 .TP 8
  98 .B \-wire
  99 Draw a wireframe rendition of the fire: this will consist only of
 100 single-pixel lines for the triangles.
 101 .SH ENVIRONMENT
 102 .PP
 103 .TP 8
 104 .B DISPLAY
 105 to get the default host and display number.
 106 .TP 8
 107 .B XENVIRONMENT
 108 to get the name of a resource file that overrides the global resources
 109 stored in the RESOURCE_MANAGER property.
 110 .SH SEE ALSO
 111 .BR X (1),
 112 .BR xscreensaver (1)
 113 .SH COPYRIGHT
 114 Copyright \(co 2001 by Eric Lassauge.
 115 Permission to use, copy, modify, distribute, and sell this software and
 116 its documentation for any purpose is hereby granted without fee,
 117 provided that the above copyright notice appear in all copies and that
 118 both that copyright notice and this permission notice appear in
 119 supporting documentation.  No representations are made about the
 120 suitability of this software for any purpose.  It is provided "as is"
 121 without express or implied warranty.
 122
 123 The original code for this hack was written by David Bucciarelli
 124 (tech.hmw@plus.it) and could be found in the demo package
 125 of Mesa (Mesa-3.2/3Dfx/demos/). This hack is the result of the merge of
 126 two of the David's demos (fire and rain).
 127
 128 .SH AUTHOR
 129 David Bucciarelli <tech.hmw@plus.it>
 130 Eric Lassauge <lassauge@mail.dotcom.fr>