Control plane API

327 declarations · 199 documented

`lava`

ActiveWindow message
Which window has the keyboard now.
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.
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
FrostRect message
One rectangle of desktop to frost behind a surface, in its own coordinates.
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.
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.
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.
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.
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."
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."