Ratatouille v0.2.0 Ratatouille.Renderer.Canvas View Source

A canvas represents a terminal window (or a subdivision of it) and a sparse mapping of positions to cells.

A %Canvas{} struct can be rendered to different output formats. This includes the primary use-case of rendering to the termbox-managed window, but also rendering to strings, which is useful for testing.

Link to this section Summary

Functions

Copies the canvas to a new one with the box consumed by the given dx and dy

Creates a new canvas with n columns (from the left) consumed

Creates a new canvas with n rows (from the top) consumed

Creates an empty canvas with the given dimensions

Copies the canvas to a new one with the box padded on each side (top, left, bottom, right) by size. Pass a negative size to remove padding

Link to this section Types

Link to this type

t() View Source
t() :: %Ratatouille.Renderer.Canvas{
  box: Ratatouille.Renderer.Box.t(),
  cells: map()
}

Link to this section Functions

Copies the canvas to a new one with the box consumed by the given dx and dy.

The box is used to indicate the empty, renderable space on the canvas, so this might be called with a dy of 1 after rendering a line of text. The box is consumed left-to-right and top-to-bottom.

Creates a new canvas with n columns (from the left) consumed.

Creates a new canvas with n rows (from the top) consumed.

Creates an empty canvas with the given dimensions.

Examples

iex> Canvas.from_dimensions(10, 20)
%Canvas{
  box: %Ratatouille.Renderer.Box{
    top_left: %ExTermbox.Position{x: 0, y: 0},
    bottom_right: %ExTermbox.Position{x: 9, y: 19}
  },
  cells: %{}
}

Copies the canvas to a new one with the box padded on each side (top, left, bottom, right) by size. Pass a negative size to remove padding.

Link to this function

render_to_string(canvas) View Source
render_to_string(Ratatouille.Renderer.Canvas.t()) :: String.t()

Link to this function

render_to_strings(canvas) View Source
render_to_strings(Ratatouille.Renderer.Canvas.t()) :: [String.t()]

Link to this function

render_to_termbox(bindings, canvas) View Source