comparison eosd.h @ 31942:710e01dbd994

Add Doxygen comments and formal parameters names in eosd.h.

31941:7ee3edf8418f

 */

#ifndef MPLAYER_EOSD_H
#define MPLAYER_EOSD_H

void eosd_init(vf_instance_t *);

void eosd_configure(mp_eosd_res_t *, int);
struct ass_image *eosd_render_frame(double, int *);
void eosd_uninit(void);

void eosd_ass_init(struct ass_library *);

#endif /* MPLAYER_EOSD_H */

31942:710e01dbd994

 */

#ifndef MPLAYER_EOSD_H
#define MPLAYER_EOSD_H

/**
 * Initialize the EOSD subsystem.
 *
 * @param vf  the video filter chain where the rendering will take place.
 */
void eosd_init(vf_instance_t *vf);

/**
 * Configure the resolution for EOSD rendering.
 * Should be called by the rendering engine whenever the resolution or
 * settings change.
 *
 * @param res      resolution and margins of the rendering area.
 * @param hinting  nonzero if hinting is useful.
 */
void eosd_configure(mp_eosd_res_t *res, int hinting);

/**
 * Renders the EOSD elements for the current frame.
 * Should be called by the rendering engine when it is about to do or
 * prepare the rendering.
 *
 * @param ts       presentation timestamp of the frame.
 * @param changed  if not NULL, will be set to 0 if the elements are
 *                 identical since the last call, 1 if they have changed
 *                 only in coordinates, and 2 if they have really changed.
 * @return         a linked list of EOSD elements.
 */
struct ass_image *eosd_render_frame(double ts, int *changed);

/**
 * Shut down the EOSD subsystem and free the associated resources.
 */
void eosd_uninit(void);

/**
 * Initialize the use of EOSD for ASS subtitles rendering.
 */
void eosd_ass_init(struct ass_library *);

#endif /* MPLAYER_EOSD_H */