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] [\-no-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 a running tally of how many frames per second are being rendered.
  53 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
  54 your GL performance.
  55 .TP 8
  56 .B \-trees \fInumber_of_trees\fP\fP
  57 Specify how much trees are drawn in the landscape.
  58 .TP 8
  59 .B \-count \fInumber_of_particles\fP\fP
  60 Specify how much fire particles are drawn. A very special case is 0
  61 wich means that you get
  62 .B rain
  63 !
  64 .TP 8
  65 .B \-size \fIviewport_size\fP\fP
  66 Viewport of GL scene is specified size if greater than 32 and less than screensize. Default value is 0, meaning full screensize.
  67 .TP 8
  68 .B \-texture
  69 Show a textured ground and the trees. This is the default.
  70 .TP 8
  71 .B \-no\-texture
  72 Disables texturing the landscape. This implies that no trees are drawn.
  73 .TP 8
  74 .B \-shadows
  75 Show a shadow for each particle on the ground. This is the default.
  76 .TP 8
  77 .B \-no\-shadows
  78 Disables the drawing of the shadows.
  79 .TP 8
  80 .B \-fog
  81 Show a fog in the distance.
  82 .TP 8
  83 .B \-no\-fog
  84 Disables the fog. This is the default.
  85 .TP 8
  86 .B \-wander
  87 Move the observer around the landscape. This is the default.
  88 .TP 8
  89 .B \-no\-wander
  90 Keep the fire centered on the screen.
  91 .TP 8
  92 .B \-trackmouse
  93 Let the mouse be a joystick to change the view of the landscape.
  94 This implies
  95 .I \-no\-wander.
  96 .TP 8
  97 .B \-no\-trackmouse
  98 Disables mouse tracking. This is the default.
  99 .TP 8
 100 .B \-wire
 101 Draw a wireframe rendition of the fire: this will consist only of
 102 single-pixel lines for the triangles.
 103 .SH ENVIRONMENT
 104 .PP
 105 .TP 8
 106 .B DISPLAY
 107 to get the default host and display number.
 108 .TP 8
 109 .B XENVIRONMENT
 110 to get the name of a resource file that overrides the global resources
 111 stored in the RESOURCE_MANAGER property.
 112 .SH SEE ALSO
 113 .BR X (1),
 114 .BR xscreensaver (1)
 115 .SH COPYRIGHT
 116 Copyright \(co 2001 by Eric Lassauge.
 117 Permission to use, copy, modify, distribute, and sell this software and
 118 its documentation for any purpose is hereby granted without fee,
 119 provided that the above copyright notice appear in all copies and that
 120 both that copyright notice and this permission notice appear in
 121 supporting documentation.  No representations are made about the
 122 suitability of this software for any purpose.  It is provided "as is"
 123 without express or implied warranty.
 124
 125 The original code for this hack was written by David Bucciarelli
 126 (tech.hmw@plus.it) and could be found in the demo package
 127 of Mesa (Mesa-3.2/3Dfx/demos/). This hack is the result of the merge of
 128 two of the David's demos (fire and rain).
 129
 130 .SH AUTHOR
 131 David Bucciarelli <tech.hmw@plus.it>
 132 Eric Lassauge <lassauge@mail.dotcom.fr>