MingaEditor.Frontend.Capabilities (Minga v0.1.0)

Copy Markdown View Source

Frontend capabilities reported during the ready handshake.

When a frontend starts, it sends a ready event with optional capability fields. The BEAM uses these to adapt rendering strategy: skipping image commands on terminals without image support, using native floating windows on GUIs, using native floating windows, etc.

Frontends that send the short 5-byte ready format get default/0 caps (TUI, RGB, wcwidth, no images, emulated floats, monospace).

Summary

Types

color_depth()
float_support()
frontend_type()
image_support()
t()
unicode_width()

Functions

default()

Returns the default capabilities (TUI with full RGB, monospace).

from_binary(arg1)

Decodes capability fields from the binary payload (6 bytes).

gui?(capabilities)

Returns true if the frontend is a native GUI (not a terminal).

images?(capabilities)

Returns true if the frontend supports inline images (kitty, sixel, or native).

native_floats?(capabilities)

Returns true if the frontend supports native floating windows (not emulated overlays).

rgb?(capabilities)

Returns true if the frontend supports full 24-bit RGB color.

Types

color_depth()

@type color_depth() :: :mono | :color_256 | :rgb

float_support()

@type float_support() :: :emulated | :native

frontend_type()

@type frontend_type() :: :tui | :native_gui | :web

image_support()

@type image_support() :: :none | :kitty | :sixel | :native

t()

@type t() :: %MingaEditor.Frontend.Capabilities{
  color_depth: color_depth(),
  float_support: float_support(),
  frontend_type: frontend_type(),
  image_support: image_support(),
  unicode_width: unicode_width()
}

unicode_width()

@type unicode_width() :: :wcwidth | :unicode_15

Functions

default()

@spec default() :: t()

Returns the default capabilities (TUI with full RGB, monospace).

from_binary(arg1)

@spec from_binary(binary()) :: t()

Decodes capability fields from the binary payload (6 bytes).

gui?(capabilities)

@spec gui?(t()) :: boolean()

Returns true if the frontend is a native GUI (not a terminal).

images?(capabilities)

@spec images?(t()) :: boolean()

Returns true if the frontend supports inline images (kitty, sixel, or native).

native_floats?(capabilities)

@spec native_floats?(t()) :: boolean()

Returns true if the frontend supports native floating windows (not emulated overlays).

rgb?(capabilities)

@spec rgb?(t()) :: boolean()

Returns true if the frontend supports full 24-bit RGB color.