Skip to content

F
ffmpeg.wasm-core
Commit 08c4dec5 authored by Stefano Sabatini's avatar Stefano Sabatini
Browse files
Options

doc/filters: alphabetically sort drawtext option listing

parent bb39c74b
Hide whitespace changes
Inline Side-by-side
Showing with 51 additions and 51 deletions
doc/filters.texi
View file @ 08c4dec5
...@@ -1262,37 +1262,19 @@ The description of the accepted parameters follows. ...@@ -1262,37 +1262,19 @@ The description of the accepted parameters follows.
@table @option @table @option
@item fontfile @item box
The font file to be used for drawing text. Path must be included. Used to draw a box around text using background color.
This parameter is mandatory. Value should be either 1 (enable) or 0 (disable).
The default value of @var{box} is 0.
@item text
The text string to be drawn. The text must be a sequence of UTF-8
encoded characters.
This parameter is mandatory if no file is specified with the parameter
@var{textfile}.
@item textfile
A text file containing text to be drawn. The text must be a sequence
of UTF-8 encoded characters.
This parameter is mandatory if no text string is specified with the
parameter @var{text}.
If both text and textfile are specified, an error is thrown.
@item x, y
The expressions which specify the offsets where text will be drawn
within the video frame. They are relative to the top/left border of the
output image.
The default value of @var{x} and @var{y} is "0".
See below for the list of accepted constants. @item boxcolor
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{boxcolor} is "white".
@item fontsize @item fix_bounds
The font size to be used for drawing text. If true, check and fix text coords to avoid clipping.
The default value of @var{fontsize} is 16.
@item fontcolor @item fontcolor
The color to be used for drawing fonts. The color to be used for drawing fonts.
...@@ -1300,27 +1282,13 @@ Either a string (e.g. "red") or in 0xRRGGBB[AA] format ...@@ -1300,27 +1282,13 @@ Either a string (e.g. "red") or in 0xRRGGBB[AA] format
(e.g. "0xff000033"), possibly followed by an alpha specifier. (e.g. "0xff000033"), possibly followed by an alpha specifier.
The default value of @var{fontcolor} is "black". The default value of @var{fontcolor} is "black".
@item boxcolor @item fontfile
The color to be used for drawing box around text. The font file to be used for drawing text. Path must be included.
Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format This parameter is mandatory.
(e.g. "0xff00ff"), possibly followed by an alpha specifier.
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 @item fontsize
The color to be used for drawing a shadow behind the drawn text. It The font size to be used for drawing text.
can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA] The default value of @var{fontsize} is 16.
form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
The default value of @var{shadowcolor} is "black".
@item ft_load_flags @item ft_load_flags
Flags to be used for loading the fonts. Flags to be used for loading the fonts.
...@@ -1351,12 +1319,44 @@ Default value is "render". ...@@ -1351,12 +1319,44 @@ Default value is "render".
For more information consult the documentation for the FT_LOAD_* For more information consult the documentation for the FT_LOAD_*
libfreetype flags. libfreetype flags.
@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 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 tabsize @item tabsize
The size in number of spaces to use for rendering the tab. The size in number of spaces to use for rendering the tab.
Default value is 4. Default value is 4.
@item fix_bounds @item text
If true, check and fix text coords to avoid clipping. The text string to be drawn. The text must be a sequence of UTF-8
encoded characters.
This parameter is mandatory if no file is specified with the parameter
@var{textfile}.
@item textfile
A text file containing text to be drawn. The text must be a sequence
of UTF-8 encoded characters.
This parameter is mandatory if no text string is specified with the
parameter @var{text}.
If both text and textfile are specified, an error is thrown.
@item x, y
The expressions which specify the offsets where text will be drawn
within the video frame. They are relative to the top/left border of the
output image.
The default value of @var{x} and @var{y} is "0".
See below for the list of accepted constants.
@end table @end table
The parameters for @var{x} and @var{y} are expressions containing the The parameters for @var{x} and @var{y} are expressions containing the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment