Skip to content

Commit f155643

Browse files
committed
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.
1 parent de64f60 commit f155643

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

src/video_display.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,8 @@ struct video_display_info {
155155
void (*run) (void *state); ///< may be NULL
156156
void (*done) (void *state);
157157
struct video_frame *(*getf) (void *state);
158-
int (*putf) (void *state, struct video_frame *frame, long long timeout_ns); ///< @copydoc display_put_frame
158+
/// @param timeout_ns display is supposed immplement the PUTF_* macros, arbitrary timeout may be removed
159+
int (*putf) (void *state, struct video_frame *frame, long long timeout_ns);
159160
int (*reconfigure_video)(void *state, struct video_desc desc);
160161
int (*ctl_property)(void *state, int property, void *val, size_t *len);
161162
void (*put_audio_frame) (void *state, const struct audio_frame *frame); ///< may be NULL

0 commit comments

Comments
 (0)