Commit 2b5daf2c authored by François Cartegnie's avatar François Cartegnie 🤞

vlc_subpicture: document callbacks

parent 7dc3b47a
......@@ -118,14 +118,21 @@ VLC_API subpicture_region_t *subpicture_region_Copy( subpicture_region_t *p_regi
typedef struct subpicture_updater_sys_t subpicture_updater_sys_t;
typedef struct
/** Optional pre update callback, usually useful on video format change.
* Will skip pf_update on VLC_SUCCESS, or will delete every region before
* the call to pf_update */
int (*pf_validate)( subpicture_t *,
bool has_src_changed, const video_format_t *p_fmt_src,
bool has_dst_changed, const video_format_t *p_fmt_dst,
/** Mandatory callback called after pf_validate and doing
* the main job of creating the subpicture regions for the
* current video_format */
void (*pf_update) ( subpicture_t *,
const video_format_t *p_fmt_src,
const video_format_t *p_fmt_dst,
mtime_t );
/** Optional callback for subpicture private data cleanup */
void (*pf_destroy) ( subpicture_t * );
subpicture_updater_sys_t *p_sys;
} subpicture_updater_t;
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment