Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
org.phosphor_works.Placement.CompositorBridge

Compositor-agnostic bridge protocol: the registration handshake and modifier reporting. The bus name that registers is the identity every compositor-only method on the daemon admits, not only the reports here. Window manipulation commands flow over org.phosphor_works.Placement.WindowTracking (applyGeometryRequested, applyGeometriesBatch, ...).

Well-known name org.phosphor_works.Placement.CompositorBridge
Source XML org.phosphor_works.Placement.CompositorBridge.xml
Methods 2
Signals 2
Properties 0

Methods

registerBridge()

Register a compositor bridge. Returns session info. Only the compositor's own process may register (the process serving the daemon's Wayland connection, or kwin_wayland as the direct child of kwin_wayland_wrapper), and only one bridge at a time, so while a registered bridge is still on the bus another connection's registration is refused. The bus name that registered is the one every compositor-only method on the daemon admits.

Arg Direction Type Description
compositorName in s (string) Compositor name (e.g. kwin, hyprland, sway).
version in s (string) Protocol API version as a decimal integer string (PhosphorProtocol::Service::ApiVersion) — NOT the compositor's release version. Peers below the daemon's minimum are rejected.
capabilities in as (array<string>) Supported capabilities: borderless, animation, borders, modifiers.
result out (sss) (struct(string,string,string)) Struct: (apiVersion, bridgeName, sessionId). sessionId == 'REJECTED' signals a rejected registration, which callers MUST check before sending stateful calls. It answers an empty compositorName, a protocol version below the minimum, a caller that is not the compositor's process, and a registration while another bridge is still on the bus.

reportModifierState()

Report keyboard modifier and mouse button state from compositor. Reserved forward surface for bridges without a drag channel, since the KWin bridge reports modifiers through the drag pipeline instead (EXPERIMENTAL interface). Only the registered compositor bridge may call it, and any other caller is answered with AccessDenied.

Arg Direction Type Description
modifiers in i (int32) Qt::KeyboardModifiers bitmask.
mouseButtons in i (int32) Qt::MouseButtons bitmask.

Signals

bridgeRegistered

A compositor bridge registered.

Arg Direction Type Description
compositorName out s (string)
version out s (string)
capabilities out as (array<string>)

modifierStateChanged

Modifier state reported by compositor.

Arg Direction Type Description
modifiers out i (int32)
mouseButtons out i (int32)