summaryrefslogtreecommitdiffstats
path: root/DOCS/man/input.rst
diff options
context:
space:
mode:
authorGraham Booker <gbooker@plexapp.com>2022-10-03 13:58:45 -0500
committersfan5 <sfan5@live.de>2023-12-08 13:37:26 +0100
commit4754bd54c7ab22c6c98283d81e22d219b3b64ade (patch)
treeec1fcd96a9337905c64defcb3e02af3bef937f21 /DOCS/man/input.rst
parentf886eb5678d0ed7eea196e577e04525248963f28 (diff)
downloadmpv-4754bd54c7ab22c6c98283d81e22d219b3b64ade.tar.bz2
mpv-4754bd54c7ab22c6c98283d81e22d219b3b64ade.tar.xz
player/command: add ability to scale overlay
Diffstat (limited to 'DOCS/man/input.rst')
-rw-r--r--DOCS/man/input.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst
index a314bfb5ed..babffdaf89 100644
--- a/DOCS/man/input.rst
+++ b/DOCS/man/input.rst
@@ -1033,7 +1033,7 @@ Input Commands that are Possibly Subject to Change
information about the key state. The special key name ``unmapped`` can be
used to match any unmapped key.
-``overlay-add <id> <x> <y> <file> <offset> <fmt> <w> <h> <stride>``
+``overlay-add <id> <x> <y> <file> <offset> <fmt> <w> <h> <stride> <dw> <dh>``
Add an OSD overlay sourced from raw data. This might be useful for scripts
and applications controlling mpv, and which want to display things on top
of the video window.
@@ -1091,6 +1091,11 @@ Input Commands that are Possibly Subject to Change
(Technically, the minimum size would be ``stride * (h - 1) + w * 4``, but
for simplicity, the player will access all ``stride * h`` bytes.)
+ ``dw`` and ``dh`` specify the (optional) display size of the overlay.
+ The overlay visible portion of the overlay (``w`` and ``h``) is scaled to
+ in display to ``dw`` and ``dh``. If parameters are not present, the
+ values for ``w`` and ``h`` are used.
+
.. note::
Before mpv 0.18.1, you had to do manual "double buffering" when updating