Mercurial > libavcodec.hg
changeset 7205:68528efbc91f libavcodec
Document av_find_opt().
| author | stefano |
|---|---|
| date | Sun, 06 Jul 2008 08:16:50 +0000 |
| parents | 83ffe1bed06e |
| children | 3092ae791531 |
| files | opt.h |
| diffstat | 1 files changed, 12 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/opt.h Sun Jul 06 07:33:09 2008 +0000 +++ b/opt.h Sun Jul 06 08:16:50 2008 +0000 @@ -85,6 +85,18 @@ } AVOption; +/** + * Looks for an option in \p obj. Looks only for the options which + * have the flags set as specified in \p mask and \p flags (that is, + * for which it is the case that opt->flags & mask == flags). + * + * @param[in] obj a pointer to a struct whose first element is a + * pointer to an #AVClass + * @param[in] name the name of the option to look for + * @param[in] unit the unit of the option to look for, or any if NULL + * @return a pointer to the option found, or NULL if no option + * has been found + */ const AVOption *av_find_opt(void *obj, const char *name, const char *unit, int mask, int flags); const AVOption *av_set_string(void *obj, const char *name, const char *val); const AVOption *av_set_double(void *obj, const char *name, double n);