[vlc-commits] window: clarify display and window handle validity

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sun Feb 24 16:15:53 2019 +0200| [c8c0d4d682319532c70295d6146c68d0e26a5580] | committer: Rémi Denis-Courmont

window: clarify display and window handle validity

The display must be valid at all times, as it might be used by the
(future) decoder device context even if the window is disabled.

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

 include/vlc_vout_window.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/vlc_vout_window.h b/include/vlc_vout_window.h
index 3c29f6b2d2..27cceaa955 100644
--- a/include/vlc_vout_window.h
+++ b/include/vlc_vout_window.h
@@ -348,7 +348,7 @@ typedef struct vout_window_t {
     /**
      * Window handle (mandatory)
      *
-     * This must be filled by the plugin upon activation.
+     * This must be filled by the plugin upon succesful vout_window_Enable().
      *
      * Depending on the \ref type above, a different member of this union is
      * used.
@@ -496,8 +496,8 @@ static inline void vout_window_UnsetFullScreen(vout_window_t *window)
  * window provider can provide a persistent connection to the display server,
  * and track any useful events, such as monitors hotplug.
  *
- * The window handle (vout_window_t.handle) and display (vout_window_t.display)
- * must remain valid and constant while the window is enabled.
+ * The window handle (vout_window_t.handle) must remain valid and constant
+ * while the window is enabled.
  */
 VLC_API
 int vout_window_Enable(vout_window_t *window, const vout_window_cfg_t *cfg);