From 9133ce7623fcf1728d682fbb51ce8caa8d3af7a3 Mon Sep 17 00:00:00 2001 From: nanahi <130121847+na-na-hi@users.noreply.github.com> Date: Fri, 2 Aug 2024 03:19:28 -0400 Subject: [PATCH] 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. --- DOCS/man/input.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/DOCS/man/input.rst b/DOCS/man/input.rst index 8ddd196ad9..5f4c9018d5 100644 --- a/DOCS/man/input.rst +++ b/DOCS/man/input.rst @@ -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.