Expand description
Native application windows owned and composed by KnottCompositor.
One authenticated connection creates one window. Frame acknowledgements mean software adoption, not physical scanout. Applications cannot assign geometry, workspaces, focus or stacking. The compositor owns those policies.
Modules§
- clipboard
- Bounded UTF-8 clipboard transactions on the compositor’s owner control socket. Scope zero is trusted session-operator access. Native window scopes are checked by KnottCompositor; these scopes are not a same-UID application sandbox.
Structs§
- Client
- Nonblocking transport. Prefer WorkerWindow when application work can block.
- Client
Options - Explicit optional protocol extensions. The default keeps the original v3 handshake byte-for-byte; unsupported opt-in endpoints fail without replay.
- Configure
- Create
- Frame
- Input
- Pixel
Buffer - Immutable shared pixels. A server-side upload retains its aggregate memory reservation until the final compositor/upload reference has been dropped.
- Pointer
Confinement Request - One bounded request against the current adopted frame. Serials start at one and increase exactly once per request; a reply releases transport credit.
- Worker
Window - One window connection with one owner-held frame/request credit. Receiving an ACK on the worker does not release credit until the application drains it. No connection, frame, input or close request is replayed after an error.
Enums§
Constants§
- MAX_
APP_ ID_ BYTES - MAX_
CLIENTS - MAX_
DIMENSION - MAX_
FRAME_ BYTES - MAX_
MEMORY_ BYTES - MAX_
TEXT_ COMMIT_ BYTES - Maximum UTF-8 byte length of one committed text input event.
- MAX_
TITLE_ BYTES - MOD_ALT
- MOD_
CTRL - MOD_
SHIFT - MOD_
SUPER - PROTOCOL_
NAME - PROTOCOL_
VERSION - TRANSFER_
TIMEOUT
Functions§
- frame_
bytes - socket_
for_ shell - socket_
from_ env - Selects one native endpoint. No display connection or discovery fallback is made.