Raxol.Terminal.ANSI.SixelGraphics.Behaviour behaviour (Raxol v0.5.0)

View Source

Behaviour for Sixel graphics support.

Summary

Types

t()

@type t() :: %{
  width: non_neg_integer(),
  height: non_neg_integer(),
  data: binary(),
  palette: map(),
  scale: {non_neg_integer(), non_neg_integer()},
  position: {non_neg_integer(), non_neg_integer()}
}

Callbacks

decode(binary)

@callback decode(binary()) :: t()

encode(t)

@callback encode(t()) :: binary()

get_data(t)

@callback get_data(t()) :: binary()

get_palette(t)

@callback get_palette(t()) :: map()

get_position(t)

@callback get_position(t()) :: {non_neg_integer(), non_neg_integer()}

get_scale(t)

@callback get_scale(t()) :: {non_neg_integer(), non_neg_integer()}

new()

@callback new() :: t()

new(non_neg_integer, non_neg_integer)

@callback new(non_neg_integer(), non_neg_integer()) :: t()

process_sequence(t, binary)

@callback process_sequence(t(), binary()) :: t()

set_data(t, binary)

@callback set_data(t(), binary()) :: t()

set_palette(t, map)

@callback set_palette(t(), map()) :: t()

set_position(t, non_neg_integer, non_neg_integer)

@callback set_position(t(), non_neg_integer(), non_neg_integer()) :: t()

set_scale(t, non_neg_integer, non_neg_integer)

@callback set_scale(t(), non_neg_integer(), non_neg_integer()) :: t()

supported?()

@callback supported?() :: boolean()