1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-08-10 06:10:52 +02:00

vf_drawtext: use @itemize environment for showing examples in docs

Beautify.
This commit is contained in:
Stefano Sabatini
2011-09-20 12:48:25 +02:00
parent 7c249d4fba
commit 751df79d29

View File

@@ -809,28 +809,34 @@ The size in number of spaces to use for rendering the tab.
Default value is 4. Default value is 4.
@end table @end table
For example the command: Some examples follow.
@itemize
@item
Draw "Test Text" with font FreeSerif, using the default values for the
optional parameters.
@example @example
drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'" drawtext="fontfile=/usr/share/fonts/truetype/freefont/FreeSerif.ttf: text='Test Text'"
@end example @end example
will draw "Test Text" with font FreeSerif, using the default values @item
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 x=100 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 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 yellow with a red box around it. Both the text and the box have an
opacity of 20%. opacity of 20%.
@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
Note that the double quotes are not necessary if spaces are not used Note that the double quotes are not necessary if spaces are not used
within the parameter list. within the parameter list.
@end itemize
For more information about libfreetype, check: For more information about libfreetype, check:
@url{http://www.freetype.org/}. @url{http://www.freetype.org/}.