mirror of https://git.ffmpeg.org/ffmpeg.git
doc/filters: alphabetically sort drawtext option listing
This commit is contained in:
parent
bb39c74b59
commit
08c4dec5d3
104
doc/filters.texi
104
doc/filters.texi
|
@ -1262,43 +1262,10 @@ 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 fontsize
|
|
||||||
The font size to be used for drawing text.
|
|
||||||
The default value of @var{fontsize} is 16.
|
|
||||||
|
|
||||||
@item fontcolor
|
|
||||||
The color to be used for drawing fonts.
|
|
||||||
Either a string (e.g. "red") or in 0xRRGGBB[AA] format
|
|
||||||
(e.g. "0xff000033"), possibly followed by an alpha specifier.
|
|
||||||
The default value of @var{fontcolor} is "black".
|
|
||||||
|
|
||||||
@item boxcolor
|
@item boxcolor
|
||||||
The color to be used for drawing box around text.
|
The color to be used for drawing box around text.
|
||||||
|
@ -1306,21 +1273,22 @@ Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format
|
||||||
(e.g. "0xff00ff"), possibly followed by an alpha specifier.
|
(e.g. "0xff00ff"), possibly followed by an alpha specifier.
|
||||||
The default value of @var{boxcolor} is "white".
|
The default value of @var{boxcolor} is "white".
|
||||||
|
|
||||||
@item box
|
@item fix_bounds
|
||||||
Used to draw a box around text using background color.
|
If true, check and fix text coords to avoid clipping.
|
||||||
Value should be either 1 (enable) or 0 (disable).
|
|
||||||
The default value of @var{box} is 0.
|
|
||||||
|
|
||||||
@item shadowx, shadowy
|
@item fontcolor
|
||||||
The x and y offsets for the text shadow position with respect to the
|
The color to be used for drawing fonts.
|
||||||
position of the text. They can be either positive or negative
|
Either a string (e.g. "red") or in 0xRRGGBB[AA] format
|
||||||
values. Default value for both is "0".
|
(e.g. "0xff000033"), possibly followed by an alpha specifier.
|
||||||
|
The default value of @var{fontcolor} is "black".
|
||||||
|
|
||||||
@item shadowcolor
|
@item fontfile
|
||||||
The color to be used for drawing a shadow behind the drawn text. It
|
The font file to be used for drawing text. Path must be included.
|
||||||
can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA]
|
This parameter is mandatory.
|
||||||
form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
|
|
||||||
The default value of @var{shadowcolor} is "black".
|
@item fontsize
|
||||||
|
The font size to be used for drawing text.
|
||||||
|
The default value of @var{fontsize} is 16.
|
||||||
|
|
||||||
@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".
|
||||||
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
|
||||||
|
|
Loading…
Reference in New Issue