Cauldron2D.Renderer (Cauldron2D v0.2.2)

Chooses between drawing a surface as pixels or as glyphs.

Modes are :text, :pixel, :kitty, :iterm2 and :sixel. :pixel means "whichever protocol this terminal has"; the other three name one outright.

A mode is resolved most specific first:

an override passed by the caller, when it is one of the modes
CAULDRON_MODE in the environment
the :cauldron_2d application environment's :mode key
:pixel

A resolved :pixel is then asked of FrenchCurve.Capability.detect/0. Its :braille answer counts as no pixel protocol, and the text renderer takes over.

Summary

Functions

describe(override \\ nil)

The resolved protocol's name, or "text", for a status bar.

mode(override \\ nil)

Whether the surface is drawn as an image or as characters.

modes()

The mode names accepted as an override, in CAULDRON_MODE, or in application config.

parse(value)

The mode value names, or nil when it names none.

protocol(override \\ nil)

The pixel protocol to draw with, or nil for the text renderer.

resolved(override \\ nil)

The mode in force before any terminal is asked: :text, :pixel, or a protocol named outright.

Functions

describe(override \\ nil)

@spec describe(atom() | nil) :: String.t()

The resolved protocol's name, or "text", for a status bar.

mode(override \\ nil)

@spec mode(atom() | nil) :: :pixel | :text

Whether the surface is drawn as an image or as characters.

:pixel when protocol/1 finds one, :text otherwise. override is a mode name, or nil to leave the choice to the environment and configuration.

modes()

@spec modes() :: [atom()]

The mode names accepted as an override, in CAULDRON_MODE, or in application config.

parse(value)

@spec parse(String.t() | nil) :: atom() | nil

The mode value names, or nil when it names none.

Surrounding whitespace and case are ignored. nil in gives nil out.

protocol(override \\ nil)

@spec protocol(atom() | nil) :: :kitty | :iterm2 | :sixel | nil

The pixel protocol to draw with, or nil for the text renderer.

override is a mode name, or nil to leave the choice to the environment and configuration. An override that is not one of modes/0 is ignored.

resolved(override \\ nil)

@spec resolved(atom() | nil) :: :text | :pixel | :kitty | :iterm2 | :sixel

The mode in force before any terminal is asked: :text, :pixel, or a protocol named outright.

override is a mode name, or nil to leave the choice to the environment and configuration. A caller that can ask the session's own terminal resolves :pixel itself; protocol/1 resolves it from the OS environment.