From f1556436b150f68056f2c062bcffaed66324cdc3 Mon Sep 17 00:00:00 2001 From: Martin Pulec Date: Fri, 2 Dec 2022 09:07:13 +0100 Subject: [PATCH] video_display.h: document timeout_ns parameter It has replaced flags recently but it doesn't seem to have much importance but it makes the modules implementing that more complex so added a hint that only BLOCKING/NONBLOCK/DISCARD are important values. --- src/video_display.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/video_display.h b/src/video_display.h index 27ecb54a7..39ad89c04 100644 --- a/src/video_display.h +++ b/src/video_display.h @@ -155,7 +155,8 @@ struct video_display_info { void (*run) (void *state); ///< may be NULL void (*done) (void *state); struct video_frame *(*getf) (void *state); - int (*putf) (void *state, struct video_frame *frame, long long timeout_ns); ///< @copydoc display_put_frame + /// @param timeout_ns display is supposed immplement the PUTF_* macros, arbitrary timeout may be removed + int (*putf) (void *state, struct video_frame *frame, long long timeout_ns); int (*reconfigure_video)(void *state, struct video_desc desc); int (*ctl_property)(void *state, int property, void *val, size_t *len); void (*put_audio_frame) (void *state, const struct audio_frame *frame); ///< may be NULL