ExTermbox v1.0.2 ExTermbox.Position View Source

Represents a position on the screen by encoding a pair of cartesian coordinates. The origin is the top-left-most character on the screen (0, 0), while x and y increase from left to right and top to bottom, respectively.

Link to this section Summary

Types

t()

Functions

translate(position, dx, dy)

Translates (shifts) a position by some delta x and y.

translate_x(pos, dx)

Translates a position by a delta x.

translate_y(pos, dy)

Translates a position by a delta y.

Link to this section Types

t()

t() :: %ExTermbox.Position{x: non_neg_integer(), y: non_neg_integer()}

Link to this section Functions

translate(position, dx, dy)

translate(t(), integer(), integer()) :: t()

Translates (shifts) a position by some delta x and y.

Returns a new %Position{}.

Examples

iex> translate(%Position{x: 0, y: 0}, 1, 2)
%Position{x: 1, y: 2}
iex> translate(%Position{x: 10, y: 0}, -1, 0)
%Position{x: 9, y: 0}

translate_x(pos, dx)

translate_x(t(), integer()) :: t()

Translates a position by a delta x.

Returns a new %Position{}.

Examples

iex> translate_x(%Position{x: 0, y: 0}, 2)
%Position{x: 2, y: 0}
iex> translate_x(%Position{x: 2, y: 0}, -1)
%Position{x: 1, y: 0}

translate_y(pos, dy)

translate_y(t(), integer()) :: t()

Translates a position by a delta y.

Returns a new %Position{}.

Examples

iex> translate_y(%Position{x: 0, y: 0}, 2)
%Position{x: 0, y: 2}
iex> translate_y(%Position{x: 0, y: 2}, -1)
%Position{x: 0, y: 1}