ElixirOpentui.Renderer (ElixirOpentui v0.2.0)

Copy Markdown View Source

Terminal renderer with diff-based updates.

Keeps the last painted frame, computes layout, paints elements, diffs the result, and outputs minimal ANSI sequences.

Can operate in two modes:

  • Live mode: writes to Terminal driver (real terminal)
  • Capture mode: returns ANSI output as iodata (for testing)

Summary

Types

t()

Functions

compute_layout(renderer, tree)

Get the layout results from the last render. Requires re-computation.

get_buffer(renderer)

Get the front buffer (last rendered frame).

new(cols, rows)

Create a new renderer with given dimensions.

render(renderer, tree, opts \\ [])

Render an element tree and return {renderer, ansi_iodata}.

render_full(renderer, tree, opts \\ [])

Force a full redraw (no diff, re-render everything).

resize(renderer, cols, rows)

Resize the renderer. Next render will be a full redraw.

Types

t()

@type t() :: %ElixirOpentui.Renderer{
  cols: non_neg_integer(),
  frame_count: non_neg_integer(),
  front: ElixirOpentui.Buffer.t(),
  rows: non_neg_integer()
}

Functions

compute_layout(renderer, tree)

Get the layout results from the last render. Requires re-computation.

get_buffer(renderer)

Get the front buffer (last rendered frame).

new(cols, rows)

Create a new renderer with given dimensions.

render(renderer, tree, opts \\ [])

Render an element tree and return {renderer, ansi_iodata}.

render_full(renderer, tree, opts \\ [])

Force a full redraw (no diff, re-render everything).

resize(renderer, cols, rows)

Resize the renderer. Next render will be a full redraw.