aboutsummaryrefslogtreecommitdiffstats
path: root/doc/filters.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-10-30 19:42:40 +0100
committerStefano Sabatini <stefasab@gmail.com>2012-10-30 23:36:36 +0100
commit2ed7e6cce56e1c2df2648095879bd7de3cff7dc9 (patch)
tree2a2ccab75b01ee81bfec57f67d73533bdc3c0869 /doc/filters.texi
parentb420b87848c4c2f10b8fb218e8f0a0cedcfeca30 (diff)
downloadffmpeg-2ed7e6cce56e1c2df2648095879bd7de3cff7dc9.tar.gz
lavfi/drawbox: extend syntax, accept named options
Diffstat (limited to 'doc/filters.texi')
-rw-r--r--doc/filters.texi17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 968c24b05a..07ae1c9b1c 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -1726,13 +1726,12 @@ specified file.
Draw a colored box on the input image.
-It accepts the syntax:
-@example
-drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
-@end example
+The filter accepts parameters as a list of @var{key}=@var{value} pairs,
+separated by ":".
-@table @option
+The description of the accepted parameters follows.
+@table @option
@item x, y
Specify the top left corner coordinates of the box. Default to 0.
@@ -1740,11 +1739,17 @@ Specify the top left corner coordinates of the box. Default to 0.
Specify the width and height of the box, if 0 they are interpreted as
the input width and height. Default to 0.
-@item color
+@item color, c
Specify the color of the box to write, it can be the name of a color
(case insensitive match) or a 0xRRGGBB[AA] sequence.
@end table
+If the key of the first options is omitted, the arguments are
+interpreted accorinding to the following syntax:
+@example
+drawbox=@var{x}:@var{y}:@var{width}:@var{height}:@var{color}
+@end example
+
Follow some examples:
@example
# draw a black box around the edge of the input image