Interface UIOverlayOptions

Overlay behavior preset. Defaults to hud. At creation, hud is strictly display-only and defaults to transparent, click-through, non-focusable, no-activate, always-on-top, and hidden from the taskbar. window permits interactive controls and initially defaults to an opaque, focusable, resizable utility window. Later mode changes reset mutable fields but preserve the create-time transparent value.

Native window title. Defaults to PowerKeys Overlay for hud and PowerKeys for window.

Native window chrome. Defaults to none for hud and custom for window; system uses the operating-system title bar and borders.

Whether the rendered overlay can be dragged. Defaults to false for hud and true for window. Enabling this on a hud also disables clickThrough unless clickThrough is explicitly supplied.

Optional modifier key required before dragging starts. Accepted case-insensitively: Ctrl/Control, Shift, Alt/Menu, Win/Meta/Super, or a left/right-specific form such as LCtrl, LeftControl, RShift, RightAlt, LWin, or RightSuper. Spaces, hyphens, and underscores are ignored. An invalid non-empty name throws when options are applied; an empty string clears the modifier.

Whether the native window can be resized by the user. Defaults to false for hud and true for window.

Minimum rendered-content width in positive integer physical pixels. Applied only when minHeight is also set. Once set, it remains until replaced or a mode change resets the options; null is invalid and does not clear it.

Minimum rendered-content height in positive integer physical pixels. Applied only when minWidth is also set. Once set, it remains until replaced or a mode change resets the options; null is invalid and does not clear it.

Maximum rendered-content width in positive integer physical pixels. Applied only when maxHeight is also set. Once set, it remains until replaced or a mode change resets the options; null is invalid and does not clear it.

Maximum rendered-content height in positive integer physical pixels. Applied only when maxWidth is also set. Once set, it remains until replaced or a mode change resets the options; null is invalid and does not clear it.

Whether the overlay stays above other windows. Defaults to true for hud and false for window.

Whether the overlay is hidden from the taskbar. Defaults to true for hud and false for window.

Whether pointer input passes through to windows underneath. Defaults to true for hud and false for window.

Whether the overlay can receive keyboard focus. Defaults to false for hud and true for window.

Whether Show avoids activating or stealing focus from the current foreground window. Defaults to true for hud and false for window.

Whole-window opacity. Finite values are clamped to the inclusive 0..1 range; defaults to 1.

Whether the overlay content should be hidden from screen capture when the platform supports it. Defaults to false.

Whether the native webview background supports transparency. This is applied only by CreateOverlay, defaulting to true for hud and false for window. Later Show or SetWindowOptions calls may repeat the existing value, but attempting to change it throws; mode changes preserve it.

Rendered client/content width in positive integer physical pixels. Defaults to 320 for hud and 360 for window.

Rendered client/content height in positive integer physical pixels. Defaults to 160 for hud and 240 for window.

Absolute x coordinate of the rendered content's top-left edge in virtual-desktop physical pixels. When supplied, x overrides anchor and offsetX on that axis and remains until replaced or a mode change resets the options; null is invalid and does not restore anchor placement.

Absolute y coordinate of the rendered content's top-left edge in virtual-desktop physical pixels. When supplied, y overrides anchor and offsetY on that axis and remains until replaced or a mode change resets the options; null is invalid and does not restore anchor placement.

Anchor within targetWindowId's outer physical bounds, or within the complete virtual desktop when no target is set. Half-pixel anchor results round to the nearest physical pixel. Defaults to top-left; invalid strings are rejected.

Signed integer physical-pixel offset from the resolved anchor on x. Used only when x is omitted; defaults to 0.

Signed integer physical-pixel offset from the resolved anchor on y. Used only when y is omitted; defaults to 0.

Optional WindowInfo.id whose outer native bounds are followed every 250 ms once detected. A target assigned after creation is detected within about one second. Anchor placement is recomputed as the target moves or resizes. If the id cannot be resolved, the overlay stays hidden instead of falling back to the virtual desktop; the target tracker then clears this field and OnTargetLost fires once. An empty string clears the target; null is treated as omitted and does not clear it.

CSS-like style for the rendered overlay root. CreateOverlay sets this initial style and SetWindowOptions replaces the whole style map; SetStyle merges instead. Renderer/CSS values use CSS logical pixels and are intentionally separate from native physical-pixel window geometry.