Raxol.Sensor.HUD (Raxol v2.3.0)

View Source

Pure functional HUD rendering for sensor data.

All functions take a region {x, y, w, h}, data, and options, and return a list of {x, y, char, fg, bg, attrs} cell tuples.

Summary

Types

cell()
region()

Functions

render_gauge(arg, value, opts \\ [])

Renders a horizontal gauge bar.

render_minimap(arg, entities, opts \\ [])

Renders a minimap using braille dot patterns.

render_sparkline(region, values, opts \\ [])

Renders a sparkline from a list of numeric values.

render_threat(arg, level, bearing_deg, opts \\ [])

Renders a threat indicator with level and bearing.

Types

cell()

@type cell() ::
  {non_neg_integer(), non_neg_integer(), String.t(), atom(), atom(), map()}

region()

@type region() :: {non_neg_integer(), non_neg_integer(), pos_integer(), pos_integer()}

Functions

render_gauge(arg, value, opts \\ [])

@spec render_gauge(region(), number(), keyword()) :: [cell()]

Renders a horizontal gauge bar.

Options:

  • label -- prefix label (default: "")
  • min -- minimum value (default: 0.0)
  • max -- maximum value (default: 100.0)
  • thresholds -- {warn, crit} percentages (default: {0.6, 0.85})

render_minimap(arg, entities, opts \\ [])

@spec render_minimap(region(), [map()], keyword()) :: [cell()]

Renders a minimap using braille dot patterns.

Entities: [%{x: 0.0..1.0, y: 0.0..1.0, char: "x"}] Maps normalized coordinates into a braille grid (2 dots wide x 4 dots tall per character).

Options:

  • border -- draw border (default: true)

render_sparkline(region, values, opts \\ [])

@spec render_sparkline(region(), [number()], keyword()) :: [cell()]

Renders a sparkline from a list of numeric values.

Options:

  • label -- prefix label (default: "")
  • min -- explicit minimum (default: auto from data)
  • max -- explicit maximum (default: auto from data)

render_threat(arg, level, bearing_deg, opts \\ [])

@spec render_threat(region(), atom(), number(), keyword()) :: [cell()]

Renders a threat indicator with level and bearing.

Options:

  • label -- prefix (default: "THREAT")

Levels: :none, :low, :medium, :high, :critical