[FFmpeg-devel] [PATCH 2/4] doc/utils: Reformat doc for color syntax and add list of supported colors

[Stefano Sabatini]

On date Sunday 2013-10-13 18:37:11 -0700, Timothy Gu encoded:
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
>  doc/utils.texi | 296 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
>  1 file changed, 290 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/utils.texi b/doc/utils.texi
> index e098ab6..6508975 100644
> --- a/doc/utils.texi
> +++ b/doc/utils.texi
> @@ -284,17 +284,301 @@ The undefined value can be expressed using the "0:0" string.
>  @anchor{color syntax}
>  @section Color
>  
> -It can be the name of a color (case insensitive match) or a
> -[0x|#]RRGGBB[AA] sequence, possibly followed by "@@" and a string
> +It can be the name of a color as defined below (case insensitive match) or a
> + at code{[0x|#]RRGGBB[AA]} sequence, possibly followed by @samp{@@} and a string
>  representing the alpha component.
>  
>  The alpha component may be a string composed by "0x" followed by an
>  hexadecimal number or a decimal number between 0.0 and 1.0, which
> -represents the opacity value (0x00/0.0 means completely transparent,
> -0xff/1.0 completely opaque).
> -If the alpha component is not specified then 0xff is assumed.
> +represents the opacity value (@samp{0x00} or @samp{0.0} means completely
> +transparent, @samp{0xff} or @samp{1.0} completely opaque). If the alpha
> +component is not specified then @samp{0xff} is assumed.
>  
> -The string "random" will result in a random color.
> +The string @samp{random} will result in a random color.

Not against.

> +
> +The following names of colors are recognized:
> + at table @samp
> + at item AliceBlue
> +0xF0F8FF
> + at item AntiqueWhite
[...]

Ideally we should be able to show these values to the user (or expose
them through an API). I'll apply the patch if no one is against, in a
day or two (since it requires some manual labour to keep it updated).
-- 
FFmpeg = Fantastic & Furious Monstrous Philosofic Entertaining Guru