Struct Capabilities 

pub struct Capabilities {
    pub truecolor: bool,
    pub sixel: bool,
    pub iterm2: bool,
    pub kitty_graphics: bool,
    pub kitty_keyboard: bool,
    pub sync_output: bool,
    pub blitters: BlitterSupport,
}

Available on crate feature crossterm only.

Runtime terminal capability probe (issue #264): read-only Capabilities snapshot plus the Blitter ladder it drives. Diagnostics-only — image rendering routes through the ladder automatically. Read-only snapshot of negotiated terminal capabilities, populated once at session enter via DA1/DA2/XTGETTCAP.

App code must not be required to branch on this — it exists for diagnostics and to drive the automatic blitter ladder (see Capabilities::best_blitter). On a headless backend (TestBackend / piped stdout) or when the probe gets no reply, every field falls back to a conservative default.

Available since 0.21.0.

Example

let caps = ui.capabilities();
if caps.sixel {
    // Diagnostics only — image rendering already routes through the ladder.
}

Fields

truecolor: bool

24-bit color confirmed (XTGETTCAP Tc/RGB or COLORTERM).

sixel: bool

Sixel graphics confirmed (DA1 attribute 4).

iterm2: bool

iTerm2 OSC 1337 inline-image protocol confirmed (env identity for iTerm2 / WezTerm / Tabby / mintty; issue #265).

kitty_graphics: bool

Kitty graphics protocol confirmed (DA2 terminal-ID heuristic).

kitty_keyboard: bool

Kitty keyboard protocol confirmed.

sync_output: bool

Synchronized output (DECSET 2026) confirmed.

blitters: BlitterSupport

Set of cell-art blitters the terminal can drive.

Implementations

impl Capabilities

pub fn best_blitter(&self) -> Blitter

Resolve the best available image blitter for this terminal.

Returns the first supported rung of the ladder (Kitty > Sixel > iTerm2 > Sextant > HalfBlock). This is total: it always returns a Blitter, falling through to Blitter::HalfBlock which every terminal supports.

Example

let _ = ui.capabilities().best_blitter();

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Capabilities

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Capabilities

fn default() -> Capabilities

Returns the “default value” for a type.

impl PartialEq for Capabilities

fn eq(&self, other: &Capabilities) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Capabilities

impl Eq for Capabilities

impl StructuralPartialEq for Capabilities