DOCS/man/input: document user-data/osc/margins

This property is used by the built-in OSC and some third-party OSC scripts
to indicate the margin they occupy so that other scripts such as
console.lua can use this value to position UI elements.
This commit is contained in:
nanahi 2024-08-02 03:19:28 -04:00 committed by Kacper Michajłow
parent d302fe0de5
commit 9133ce7623
1 changed files with 8 additions and 0 deletions

View File

@ -3555,6 +3555,14 @@ Property list
upon, and writing to these properties may prevent builtin scripts from working
properly.
Currently, the following properties have defined special semantics:
``user-data/osc/margins``
This property is written by an OSC implementation to indicate the margins that it
occupies. Its sub-properties ``l``, ``r``, ``t``, and ``b`` should all be set to
the left, right, top, and bottom margins respectively.
Values are between 0.0 and 1.0, normalized to window width/height.
Sub-paths can be accessed directly; e.g. ``user-data/my-script/state/a`` can be
read, written, or observed.