Skip to main content

Crate cellix_term

Crate cellix_term 

Source
Expand description

Terminal side of Cellix: choosing a rendering tier and presenting grids.

Structs§

Bleed
How far tiles reach past the text area. Ghostty doesn’t clip images, so a tile can cover its right and bottom padding, which no cell can. Left and top stay out of reach, and the frame there is the terminal’s own colour.
CellBackend
Styled text cells. Works everywhere, so every feature must work here.
Env
What detection found about the environment.
PixelBackend
Renders each row once as a tile, keeps it in the terminal’s image store, and moves it by reference, so only new content crosses the wire.
Smooth
How a region animates. Direct placement only, since only that can sit between cells.

Enums§

Multiplexer
Notice
Which sequence a terminal reads.
Placement
How tiles reach the screen. See the tier table in docs/DESIGN.md.
Tier
How frames reach the terminal. See the tier table in docs/DESIGN.md.

Constants§

DEFAULT_QUOTA
Decoded image memory Cellix keeps in the terminal. Kitty’s default limit is 320 MB and other terminals’ are lower, so this stays well inside them.

Traits§

Backend
Presents a grid. Implementations send only what changed since the last call.

Functions§

background
Asks the terminal for its background again, as when Cellix comes back into focus: it may have turned from light to dark since Cellix started. Must run in raw mode, between reads of input. Gives whether it’s light, and its colour, when the terminal said.
detect
Works out what this terminal can do. Must run in raw mode, before input is read.
notification
The bytes that show title and body as a notification. Inside tmux they’re wrapped to go past it to the terminal, which tmux allows with allow-passthrough.
row_key
What a row looks like, as a key: rows with the same key draw the same pixels.
select_tier
Picks a tier. A user setting wins. Otherwise this is the design’s table: tmux needs placeholders, and anything else that speaks Kitty graphics gets direct placement.
terminal_names
What the terminal is called, from the environment through var, and from tmux when Cellix runs inside it: there TERM names tmux, and over SSH it’s often a stand-in.