diff options
author | Ganesh Ajjanagadde <gajjanagadde@gmail.com> | 2015-10-15 05:56:54 +0300 |
---|---|---|
committer | Ganesh Ajjanagadde <gajjanagadde@gmail.com> | 2015-10-18 01:58:38 +0300 |
commit | 62144b225d077b201a723d843d38c6d15cb087f9 (patch) | |
tree | af96927f7c7ac29d27afd87609ef174402025319 | |
parent | 7303962f1467e302906561be53ca4d51abbe5522 (diff) |
avfilter/internal: Doxygen for ff_fmt_is_in
This clarifies and adds Doxygen for ff_fmt_is_in.
Reviewed-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Ganesh Ajjanagadde <gajjanagadde@gmail.com>
-rw-r--r-- | libavfilter/internal.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/libavfilter/internal.h b/libavfilter/internal.h index d92e1204f5..1cc6bf3b10 100644 --- a/libavfilter/internal.h +++ b/libavfilter/internal.h @@ -152,7 +152,15 @@ struct AVFilterInternal { avfilter_execute_func *execute; }; -/** Tell is a format is contained in the provided list terminated by -1. */ +/** + * Tell if an integer is contained in the provided -1-terminated list of integers. + * This is useful for determining (for instance) if an AVPixelFormat is in an + * array of supported formats. + * + * @param fmt provided format + * @param fmts -1-terminated list of formats + * @return 1 if present, 0 if absent + */ int ff_fmt_is_in(int fmt, const int *fmts); /* Functions to parse audio format arguments */ |