summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2013-02-05 00:10:31 +0100
committerStefano Sabatini <stefasab@gmail.com>2013-02-05 00:12:55 +0100
commit0e2b0033f161e9630904221628a1575807851b92 (patch)
tree4c6665524438d22234fae7f8cbdbd849b595cf8e /doc
parent2d22e97f6d7322f964d33ec5c96114b1b3a48922 (diff)
doc/filters: apply various rendering changes to the showspectrum docs
In particular: always use @table @samp for showing constant tables, add a few empty lines for improving readability, and specify default value when missing.
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi36
1 files changed, 29 insertions, 7 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index c04930f70d..76a73e6dad 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -6052,22 +6052,42 @@ The filter accepts the following named parameters:
@table @option
@item size, s
Specify the video size for the output. Default value is @code{640x512}.
+
@item slide
Specify if the spectrum should slide along the window. Default value is
@code{0}.
+
@item mode
-Specify display mode. Can be either @code{combined}: all channels are
-displayed in the same row, or @code{separate}: all channels are displayed
-in separate rows. Default value is @code{combined}.
+Specify display mode.
+
+It accepts the following values:
+@table @samp
+@item combined
+all channels are displayed in the same row
+@item separate
+all channels are displayed in separate rows
+@end table
+
+Default value is @samp{combined}.
+
@item color
-Specify display color mode. Can be either @code{channel}: each channel
-is displayed in a separate color, or @code{intensity}: each channel is
-displayed using the same color scheme. Default value is @code{channel}.
+Specify display color mode.
+
+It accepts the following values:
+@table @samp
+@item channel
+each channel is displayed in a separate color
+@item intensity
+each channel is is displayed using the same color scheme
+@end table
+
+Default value is @samp{channel}.
+
@item scale
Specify scale used for calculating intensity color values.
It accepts the following values:
-@table @option
+@table @samp
@item lin
linear
@item sqrt
@@ -6078,6 +6098,8 @@ cubic root
logarithmic
@end table
+Default value is @samp{sqrt}.
+
@item saturation
Set saturation modifier for displayed colors. Negative values provide
alternative color scheme. @code{0} is no saturation at all.