summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAvi Halachmi (:avih) <avihpit@yahoo.com>2020-11-12 11:43:23 +0200
committeravih <avih@users.noreply.github.com>2020-11-16 20:29:58 +0200
commit3710c154d4ce26541b42ce79c99af2016925191b (patch)
tree09e22aa3b8c848e4ccd73346c7cd967ce51ec454
parent58004ea2ef1a14da51b3f46e1c8565c0a3a91ee0 (diff)
downloadmpv-3710c154d4ce26541b42ce79c99af2016925191b.tar.bz2
mpv-3710c154d4ce26541b42ce79c99af2016925191b.tar.xz
docs/input.rst: document the mouse-pos property
-rw-r--r--DOCS/man/input.rst14
1 files changed, 14 insertions, 0 deletions
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