Logo FS-Skia-UI

Hud Module

Types

Type Description

Band

One region along the reserved axis: `Offset` from the axis origin, `Size` the extent.

BandEdge

Which edge of the axis the reserved HUD band occupies.

HudLayout

The reserved HUD band plus the clamped gameplay remainder; the two `Band`s are non-overlapping and partition `surface`.

Functions and values

Function or value Description

reserveHudBand surface bandSize edge

Full Usage: reserveHudBand surface bandSize edge

Parameters:
    surface : float
    bandSize : float
    edge : BandEdge

Returns: HudLayout

Reserve a HUD band of `bandSize` at `edge` of an axis of extent `surface`, returning the band and the clamped gameplay remainder. Clamp invariants: `HudBand.Size = min bandSize surface`, `Gameplay.Size = surface - HudBand.Size ≥ 0`, and the two bands partition `surface` without overlap.

surface : float
bandSize : float
edge : BandEdge
Returns: HudLayout

Type something to start searching.