RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2025-03-22 03:08:33 +00:00
Code Issues Releases Wiki Activity

docs/input.rst: document the mouse-pos property

Browse Source
This commit is contained in:
Avi Halachmi (:avih) 2020-11-12 11:43:23 +02:00 committed by avih
parent 58004ea2ef
commit 3710c154d4
1 changed files with 14 additions and 0 deletions

14
DOCS/man/input.rst
View File

@ -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