[vlc-commits] vout: update vout display documentation

[Thomas Guillem]

vlc | branch: master | Thomas Guillem <thomas at gllm.fr> | Mon Mar  1 17:43:34 2021 +0100| [0316e5c0765c49b7050e363c0f627e20c8b56ba7] | committer: Thomas Guillem

vout: update vout display documentation

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=0316e5c0765c49b7050e363c0f627e20c8b56ba7
---

 include/vlc_vout_display.h | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/include/vlc_vout_display.h b/include/vlc_vout_display.h
index 36018a9542..868a3bb505 100644
--- a/include/vlc_vout_display.h
+++ b/include/vlc_vout_display.h
@@ -247,8 +247,9 @@ struct vlc_display_operations
      * or upload the picture to video memory. If supported, this can also
      * queue the picture to be shown asynchronously at the given date.
      *
-     * If prepare is not \c NULL, there is an implicit guarantee that display
-     * will be invoked with the exact same picture afterwards:
+     *
+     * If prepare and display are not \c NULL, there is an implicit guarantee
+     * that display will be invoked with the exact same picture afterwards:
      * prepare 1st picture, display 1st picture, prepare 2nd picture, display
      * 2nd picture, and so on.
      *
@@ -269,6 +270,9 @@ struct vlc_display_operations
      * This callback is invoked at the time when the picture should be shown.
      * The picture must be displayed as soon as possible.
      *
+     * If NULL, prepare must be valid. In that case, the plugin can handle
+     * asynchronous display at the time given by the prepare call.
+     *
      * \note The picture buffers may have multiple references.
      * Therefore the pixel content of the picture or of the subpicture
      * must not be changed.