u/sink: Fix description of u_sink_simple_queue

Update the comment describing the u_sink_simple_queue to
explain that it buffers a single frame to a new thread,
replacing it as new frames come in if it hasn't been consumed
yet.

Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2188>
This commit is contained in:
Jan Schmidt 2023-07-16 03:37:23 +10:00 committed by Marge Bot
parent 30ae628b83
commit 32e496ab90

View file

@ -16,9 +16,10 @@
/*!
* An @ref xrt_frame_sink queue, any frames received will be pushed to the
* downstream consumer on the queue thread. Will drop frames should multiple
* frames be queued up.
* An @ref xrt_frame_sink queue that holds buffers a single xrt_frame
* and passes it to the downstream consumer on the queue thread. If another
* frame arrives before the current frame is consumed, the new frame replaces
* the old one.
*
* @implements xrt_frame_sink
* @implements xrt_frame_node