Raxol.Terminal.Render.UnifiedRenderer (Raxol v0.5.0)

View Source

Provides a unified interface for terminal rendering operations.

Summary

Functions

Returns a specification to start this module under a supervisor.

Cleans up resources.

Renders the current state.

Renders the current state with a specific renderer ID.

Resizes the renderer.

Sets cursor visibility.

Sets the window title.

Starts the renderer.

Updates the renderer configuration with a single argument.

Updates the renderer configuration.

Types

t()

@type t() :: %Raxol.Terminal.Render.UnifiedRenderer{
  buffer: Raxol.Terminal.Buffer.t(),
  cursor_visible: boolean(),
  screen: Screen.t(),
  style: Raxol.Terminal.Style.t(),
  title: String.t()
}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

cleanup(state)

@spec cleanup(t()) :: :ok

Cleans up resources.

render(state)

@spec render(t()) :: :ok

Renders the current state.

render(state, renderer_id)

@spec render(t(), String.t()) :: :ok

Renders the current state with a specific renderer ID.

resize(width, height)

@spec resize(non_neg_integer(), non_neg_integer()) :: :ok

Resizes the renderer.

set_cursor_visibility(visible)

@spec set_cursor_visibility(boolean()) :: :ok

Sets cursor visibility.

set_title(title)

@spec set_title(String.t()) :: :ok

Sets the window title.

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

Starts the renderer.

update_config(config)

@spec update_config(map()) :: :ok

Updates the renderer configuration with a single argument.

update_config(state, config)

@spec update_config(t(), map()) :: :ok

Updates the renderer configuration.