Ratatouille

v0.3.0

Ratatouille v0.3.0 Ratatouille.Renderer.Canvas View Source

A canvas represents a terminal window, a subvision of it for rendering, 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

Types

t()

Functions

consume(canvas, dx, dy)

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

consume_columns(canvas, n)

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

consume_rows(canvas, n)

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

fill_background(canvas)
from_dimensions(x, y)

Creates an empty canvas with the given dimensions

padded(canvas, size)

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

put_box(canvas, render_box)
render_to_string(canvas)
render_to_strings(canvas)
render_to_termbox(bindings, canvas)
translate(canvas, dx, dy)

Link to this section Types

Link to this type

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

Link to this section Functions

Link to this function

consume(canvas, dx, dy) View Source 
consume(Ratatouille.Renderer.Canvas.t(), integer(), integer()) ::
  Ratatouille.Renderer.Canvas.t()

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

The render 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.

Link to this function

consume_columns(canvas, n) View Source 
consume_columns(Ratatouille.Renderer.Canvas.t(), integer()) ::
  Ratatouille.Renderer.Canvas.t()

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

Link to this function

consume_rows(canvas, n) View Source 
consume_rows(Ratatouille.Renderer.Canvas.t(), integer()) ::
  Ratatouille.Renderer.Canvas.t()

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

Link to this function

fill_background(canvas) View Source

Link to this function

from_dimensions(x, y) View Source 
from_dimensions(non_neg_integer(), non_neg_integer()) ::
  Ratatouille.Renderer.Canvas.t()

Creates an empty canvas with the given dimensions.

Examples 

iex> Canvas.from_dimensions(10, 20)
%Canvas{
  outer_box: %Ratatouille.Renderer.Box{
    top_left: %ExTermbox.Position{x: 0, y: 0},
    bottom_right: %ExTermbox.Position{x: 9, y: 19}
  },
  render_box: %Ratatouille.Renderer.Box{
    top_left: %ExTermbox.Position{x: 0, y: 0},
    bottom_right: %ExTermbox.Position{x: 9, y: 19}
  },
  cells: %{}
}
Link to this function

padded(canvas, size) View Source 
padded(Ratatouille.Renderer.Canvas.t(), integer()) ::
  Ratatouille.Renderer.Canvas.t()

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

Link to this function

put_box(canvas, render_box) View Source 
put_box(Ratatouille.Renderer.Canvas.t(), Ratatouille.Renderer.Box.t()) ::
  Ratatouille.Renderer.Canvas.t()

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

Link to this function

translate(canvas, dx, dy) View Source 
translate(Ratatouille.Renderer.Canvas.t(), integer(), integer()) ::
  Ratatouille.Renderer.Canvas.t()