From 3710c154d4ce26541b42ce79c99af2016925191b Mon Sep 17 00:00:00 2001
From: "Avi Halachmi (:avih)" <avihpit@yahoo.com>
Date: Thu, 12 Nov 2020 11:43:23 +0200
Subject: [PATCH] docs/input.rst: document the mouse-pos property
---
DOCS/man/input.rst | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index 54bd244b26..64af021344 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -2567,6 +2567,20 @@ Property list
Any of these properties may be unavailable or set to dummy values if the
VO window is not created or visible.
+``mouse-pos``
+ Read-only - last known mouse position, normalizd to OSD dimensions.
+
+ Has the following sub-properties (which can be read as ``MPV_FORMAT_NODE``
+ or Lua table with ``mp.get_property_native``):
+
+ ``mouse-pos/x``, ``mouse-pos/y``
+ Last known coordinates of the mouse pointer.
+
+ ``mouse-pos/hover``
+ Boolean - whether the mouse pointer hovers the video window. The
+ coordinates should be ignored when this value is false, because the
+ video backends update them only when the pointer hovers the window.
+
``sub-text``
The current subtitle text regardless of sub visibility. Formatting is
stripped. If the subtitle is not text-based (i.e. DVD/BD subtitles), an