summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorJames Ross-Gowan <rossy@jrg.systems>2017-08-08 21:34:38 +1000
committerJames Ross-Gowan <rossy@jrg.systems>2017-09-03 20:31:44 +1000
commit957e9a37db6611fe0879bd2097131df5e09afd47 (patch)
treeb346371417acd0476a60e2c1ecde20c8548d14ba /DOCS
parent449d9725c91af467b154817dfd0603d80ba7f00b (diff)
downloadmpv-957e9a37db6611fe0879bd2097131df5e09afd47.tar.bz2
mpv-957e9a37db6611fe0879bd2097131df5e09afd47.tar.xz
input: use mnemonic names for mouse buttons
mpv's mouse button numbering is based on X11 button numbering, which allows for an arbitrary number of buttons and includes mouse wheel input as buttons 3-6. This button numbering was used throughout the codebase and exposed in input.conf, and it was difficult to remember which physical button each number actually referred to and which referred to the scroll wheel. In practice, PC mice only have between two and five buttons and one or two scroll wheel axes, which are more or less in the same location and have more or less the same function. This allows us to use names to refer to the buttons instead of numbers, which makes input.conf syntax a lot easier to remember. It also makes the syntax robust to changes in mpv's underlying numbering. The old MOUSE_BTNx names are still understood as deprecated aliases of the named buttons. This changes both the input.conf syntax and the MP_MOUSE_BTNx symbols in the codebase, since I think both would benefit from using names over numbers, especially since some platforms don't use X11 button numbering and handle different mouse buttons in different windowing system events. This also makes the names shorter, since otherwise they would be pretty long, and it removes the high-numbered MOUSE_BTNx_DBL names, since they weren't used. Names are the same as used in Qt: https://doc.qt.io/qt-5/qt.html#MouseButton-enum
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/interface-changes.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/DOCS/interface-changes.rst b/DOCS/interface-changes.rst
index 0702099553..479819a390 100644
--- a/DOCS/interface-changes.rst
+++ b/DOCS/interface-changes.rst
@@ -59,6 +59,10 @@ Interface changes
obscure use that stopped working with the change above. It was also
prone to be confused with a feature not implemented by it: auto did _not_
mean that deinterlacing was enabled on demand.)
+ - add shortened mnemonic names for mouse button bindings, eg. mbtn_left
+ the old numeric names (mouse_btn0) are deprecated
+ - remove mouse_btn3_dbl and up, since they are only generated for buttons
+ 0-2 (these now print an error when sent from the 'mouse' command)
--- mpv 0.26.0 ---
- remove remaining deprecated audio device options, like --alsa-device
Some of them were removed in earlier releases.