Control plane API

441 declarations · 280 documented

`lava`

ActiveWindow message
Which window has the keyboard now.
AlreadyRunning exception
CreateWindow with singleInstance, and the application already has a window. That window has been brought to the current workspace and activated — what a second launch is asking for — and surfaceId is it. Not a failure the caller should report: it is the cue to exit quietly.
Appearance message
What the desktop looks like, for a client that wants to match it.
ArenaNotFound exception
AtlasDumpFailed exception
DumpAtlasImages could not write the pages.
BackdropBlur message
The desktop under a plate, blurred. radius in layout pixels. A plate without one is not drawn: a sharp plate is not supported yet.
BackdropEffect variant
One thing a plate does to the desktop under it. They stack: a plate is blurred, then bent and lit, then grained, whatever order they are listed in. Named one of a list rather than fields of the plate because a message cannot grow — adding a field changes the layout every client built against the older stubs reads — and a new kind of effect can be added here as a new arm, which a compositor that does not know it skips.
BackdropFrost message
The grain of frosted glass on a plate, 0…1.
BackdropGlass message
The plate as glass. refraction is how far its rim bends what is under it, in pixels (0: flat); rim, 0…1, the light the rim catches; magnification, 1…4, how much larger what is under the plate is drawn, about its centre (1: none).
BackdropPlate message
A frosted rectangle of the desktop behind a surface, and what it does. x,y,w,h in the surface's own coordinates; w or h of 0 is the whole surface. cornerRadius rounds the plate to match what sits on it.
Capture message
A PNG and the size it encoded to.
CaptureFailed exception
The surface exists but there was nothing to read back — it has not drawn a frame yet, or the read-back itself failed.
Compositor interface
CursorShape enum
The pointer image a client asks for over its own surface.
DragImage message
What hangs off the cursor during a drag out of a Lava window, as the client drew it. See StartDrag.
FocusAck message
Panel → compositor on the same stream: "I am showing this one now."
FontNotFound exception
GpuAllocation message
One allocation, and who asked for it.
GpuAtlas message
One atlas page.
GpuReport message
Everything the compositor knows about its own GPU memory.
GpuTexture message
One entry in the shared texture cache.
GpuWindow message
One canvas window and what its attachments cost.
IdleSettings message
[idle] in lava.conf: when the session locks and the screens go off. Seconds; 0 is never.
ImageInfo message
A registered image: the id to put in a draw command, and the size it actually decoded to.
ImageNotFound exception
The file does not exist, or is not an image this renderer can decode.
Images interface
Image registration that does not stop the desktop.
ImageTurn enum
A quarter turn applied to an image as it is decoded.
InputAck message
App → renderer on the same stream: "I have consumed everything through serial."
InputEvent message
One raw input event, renderer → app.
InputRect message
One rectangle a surface accepts pointer input in, in its own coordinates.
KeyBinding message
One shortcut the compositor takes before any client sees the key.
KeyboardLayout message
One layout — or one variant of one — that this machine's xkb offers.
KeyboardSettings message
The keyboard, as xkb is currently set up.
LockAttempt message
Lock screen → compositor: "is this the password?"
LockRefused exception
CreateLockSurface was refused: the session is not locked, or the caller is not the lock screen the compositor started for this lock.
LockState message
Compositor → lock screen.
LockStatus enum
Where the session lock is, as the lock screen needs to draw it.
MenuChoice message
Compositor → the client that asked for a menu: "the user picked this."
MenuChoiceAck message
Client → compositor on the same stream: "I have that one."
MenuItem message
One row of a context menu.
MenuItemKind enum
What one row is.
MenuReply message
Menu client → compositor: "the user picked this", or "they did not".
MenuRequest message
Compositor → menu client: "open this, here."
OutputInfo message
One screen, as it is right now.
OutputMode message
One mode a screen can run at.
OutputNotFound exception
No screen by that name is connected.
OutputRequest message
What to set a screen to.
PanelArea message
Whether anything is in the way of a panel.
PanelAreaAck message
Panel → compositor: "I have drawn myself for this answer."
PanelEdge enum
Which screen edge a panel is docked to.
PixelArenaNotFound exception
The client's pixel arena could not be opened, or the handle does not name one this connection attached.
PixelFormat enum
Byte order of one pixel in a pixel arena, named in memory order.
PixelRegion message
One rectangle of pixels inside an attached pixel arena.
PixelRegionInvalid exception
A region of a pixel arena that does not describe pixels inside it: the rectangle runs past the end of the arena, the stride is shorter than a row, or a side is zero or too large. Distinct from PixelArenaNotFound because the arena is fine and the caller's arithmetic is not.
PointerSettings message
[mouse] and [touchpad] in lava.conf, and [render] scroll-easing: how the pointer moves and how a scroll feels.
SettingsWriteFailed exception
The change was applied but could not be saved, so it will not survive a restart.
SurfaceNotFound exception
The surface id is not one this compositor handed out, or its client has already let it go.
SystemTheme message
Which LavaUI Theme every client that uses system colours should wear.
ThemeAck message
Client → compositor: "I have applied this theme."
VideoBufferInvalid exception
A video buffer the compositor would not take: the handle is not one this connection attached, the layout is not one it can import, or the connection cannot carry a file descriptor at all.
VideoBufferLayout message
The layout of one single-plane dma-buf the client allocated: what gbm_bo_get_* says about it. The fd itself travels beside the message.
VideoTarget message
Where a client must render a frame for the compositor to sample it without a copy through the CPU: which GPU, and which layouts of DRM_FORMAT_ABGR8888 that GPU can import.
Wallpaper message
What the desktop itself is painted with, behind every window.
WallpaperUnreadable exception
That file is not a picture this compositor can put on the desktop.
WindowFrame enum
Who draws a window's non-client area.
WindowInfo message
One window, as a dock or a task list has to see it.
WindowList message
Every window the compositor has, and which workspace is on screen.
WindowListAck message
Shell → compositor: "I have drawn this list."
WindowTraits message
What a window is, beyond its size and who draws its frame. All false is an ordinary window: CreateWindow with these zeroed is CreateSurface.