patch checklist:git format-patch

[ffmpeg] / doc / filters.texi

diff --git a/doc/filters.texi b/doc/filters.texi
index 80f6fb0a9b9f510615605bba321a389462524cc5..281fe3da55b9293e580a25c0a13998cb62b41d6b 100644 (file)
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -410,14 +410,24 @@ The default value of @var{fontcolor} is "black".
 The color to be used for drawing box around text.
 Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
 (e.g. "0xff00ff"), possibly followed by an alpha specifier.
-
-The default value of @var{bgcolor} is "white".
+The default value of @var{boxcolor} is "white".
 
 @item box
 Used to draw a box around text using background color.
 Value should be either 1 (enable) or 0 (disable).
 The default value of @var{box} is 0.
 
+@item shadowx, shadowy
+The x and y offsets for the text shadow position with respect to the
+position of the text. They can be either positive or negative
+values. Default value for both is "0".
+
+@item shadowcolor
+The color to be used for drawing a shadow behind the drawn text.  It
+can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
+form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
+The default value of @var{shadowcolor} is "black".
+
 @item ft_load_flags
 Flags to be used for loading the fonts.
 
@@ -454,12 +464,22 @@ Default value is 4.
 
 For example the command:
 @example
-drawtext="fontfile=FreeSerif.ttf: text='Test Text': x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: boxcolor=red@@0.2: box=1"
+drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
+@end example
+
+will draw "Test Text" with font FreeSerif, using the default values
+for the optional parameters.
+
+The command:
+@example
+drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text':\
+          x=100: y=50: fontsize=24: fontcolor=yellow@@0.2: box=1: boxcolor=red@@0.2"
 @end example
 
-will draw 'Test Text' with font FreeSerif of size 24 at position
-(100,50), text color is yellow, and draw a red box around text. Both
-the text and the box have an opacity of 20%.
+will draw 'Test Text' with font FreeSerif of size 24 at position x=100
+and y=50 (counting from the top-left corner of the screen), text is
+yellow with a red box around it. Both the text and the box have an
+opacity of 20%.
 
 Note that the double quotes are not necessary if spaces are not used
 within the parameter list.