[vlc-commits] display: add more documentation for display_info.handle_mouse_hide

[Steve Lhomme]

vlc | branch: master | Steve Lhomme <robUx4 at videolabs.io> | Tue Aug  8 15:22:31 2017 +0200| [10216c788dc302d9d6709efbb216fd92657a55e6] | committer: Jean-Baptiste Kempf

display: add more documentation for display_info.handle_mouse_hide

In all cases this flag means that the vout has a custom Window and handles the
mouse event itself, including showing/hiding the mouse.

For the auto-hiding to work such vout need to call either
vout_display_SendEventMouseMoved or vout_display_SendEventMouseState to notify
the core of mouse events. And they all do that.

Signed-off-by: Jean-Baptiste Kempf <jb at videolan.org>

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

 include/vlc_vout_display.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/include/vlc_vout_display.h b/include/vlc_vout_display.h
index e612bac48c..80761c8762 100644
--- a/include/vlc_vout_display.h
+++ b/include/vlc_vout_display.h
@@ -128,7 +128,9 @@ typedef struct {
 typedef struct {
     bool is_slow;                           /* The picture memory has slow read/write */
     bool has_double_click;                  /* Is double-click generated */
-    bool needs_hide_mouse;                  /* Needs VOUT_DISPLAY_HIDE_MOUSE */
+    bool needs_hide_mouse;                  /* Needs VOUT_DISPLAY_HIDE_MOUSE,
+                                             * needs to call vout_display_SendEventMouseMoved()
+                                             * or vout_display_SendEventMouseState() */
     bool has_pictures_invalid;              /* Will VOUT_DISPLAY_EVENT_PICTURES_INVALID be used */
     const vlc_fourcc_t *subpicture_chromas; /* List of supported chromas for subpicture rendering. */
 } vout_display_info_t;