diff options
Diffstat (limited to 'DOCS')
-rw-r--r-- | DOCS/man/input.rst | 25 | ||||
-rw-r--r-- | DOCS/man/lua.rst | 1 |
2 files changed, 26 insertions, 0 deletions
diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index a6f77dff0a..651ae7f645 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -1019,6 +1019,31 @@ Input Commands that are Possibly Subject to Change It's possible that future mpv versions will randomly change how Z order between different OSD formats and builtin OSD is handled. + ``hidden`` + If set to ``yes``/true, do not display this (default: no). + + ``compute_bounds`` + If set to ``yes``/true, attempt to determine bounds and write them to + the command's result value as ``x0``, ``x1``, ``y0``, ``y1`` rectangle + (default: no). If the rectangle is empty, not known, or somehow + degenerate, it is not set. ``x1``/``y1`` is the coordinate of the bottom + exclusive corner of the rectangle. + + The result value may depend on the VO window size, and is based on the + last known window size at the time of the call. This means the results + may be different from what is actually rendered. + + For ``ass-events``, the result rectangle is recomputed to ``PlayRes`` + coordinates (``res_x``/``res_y``). If window size is not known, a + fallback is chosen. + + You should be aware that this mechanism is very inefficient, as it + renders the full result, and then uses the bounding box of the rendered + bitmap list (even if ``hidden`` is set). It will flush various caches. + Its results also depend on the used libass version. + + This feature is experimental, and may change in some way again. + Note: always use named arguments (``mpv_command_node()``). Scripts should use the ``mp.create_osd_overlay()`` helper instead of invoking this command directly. diff --git a/DOCS/man/lua.rst b/DOCS/man/lua.rst index a9fc02ed44..92debe8a75 100644 --- a/DOCS/man/lua.rst +++ b/DOCS/man/lua.rst @@ -599,6 +599,7 @@ are useful only in special situations. ``update()`` Commit the OSD overlay to the screen, or in other words, run the ``osd-overlay`` command with the current fields of the overlay table. + Returns the result of the ``osd-overlay`` command itself. ``remove()`` Remove the overlay from the screen. A ``update()`` call will add it |