Struct StatBar 

pub struct StatBar<'a> { /* private fields */ }

A labeled stat bar: label, a bar filling current / max of the remaining width colored by super::Meter, and a trailing "current/max" readout.

Only the first row of area is used. Same layout and coloring as super::Gauge, but for integer current/max pairs (health, mana, stamina) with a literal readout instead of a percentage: "45/100" reads as a stat, not a load. max == 0 renders as an empty, unfilled bar with a "0/0" readout rather than a special-cased blank output. If current exceeds max (e.g. a temporarily buffed stat), the bar fill still caps at 100%, but the readout shows the true, uncapped numbers ("120/100") so the overflow stays visible in text. label_style defaults to Theme::DARK’s dim role (as if StatBar::theme had been called); set it with StatBar::label_style. The fill (and readout) color defaults to super::Meter’s green→yellow→red load ramp, which reads backwards for a health/mana/stamina stat (full renders as danger, not safe); override it with StatBar::fill_color.

Examples

use retroglyph_core::grid::{Grid, Rect};
use retroglyph_ui::{StatBar, Surface, Widget};

let area = Rect::new(0, 0, 20, 1);
let mut grid = Grid::new(20, 1);
StatBar::new("HP", 45, 100).render(&mut Surface::new(&mut grid, area, 0));

Implementations

impl<'a> StatBar<'a>

pub fn new(label: &'a str, current: u32, max: u32) -> Self

A stat bar for label, reading current out of max, with label_style styled from Theme::DARK (as if StatBar::theme had been called).

pub const fn label_style(self, style: Style) -> Self

Set the label’s style.

pub const fn fill_color(self, fill_color: fn(f32) -> Color) -> Self

Overrides the bar’s fill (and readout text) color from super::Meter’s default green→yellow→red load ramp to fill_color, called with current / max clamped to 0.0..=1.0.

The default ramp reads backwards for a descending stat like health: full renders as danger (red), not safe. Supply a ramp that fits instead, e.g. |r| Color::lerp(Color::RED, Color::GREEN, r). A plain fn pointer rather than a boxed closure, so StatBar stays Copy; a non-capturing closure like the one above coerces to it automatically.

pub fn theme(self, theme: Theme) -> Self

Sets label_style to theme.dim on theme.panel_bg, the same mapping (and the same “assumes it’s drawn on theme.panel_bg” caveat) as super::Gauge::theme; see its doc comment for the full explanation, including why the bar’s own load-colored fill stays outside theme’s role palette, unless overridden separately with StatBar::fill_color.

Call before any manual StatBar::label_style override you want to keep.

pub fn theme_on(self, theme: Theme, bg: Color) -> Self

Same as StatBar::theme, but label_style is drawn on bg instead of theme.panel_bg: for a stat bar drawn directly on a backdrop other than a themed super::Panel/super::Modal’s fill. StatBar::theme is exactly theme_on(theme, theme.panel_bg).

Trait Implementations

impl<'a> Clone for StatBar<'a>

fn clone(&self) -> StatBar<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for StatBar<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Widget for StatBar<'_>

fn render(&self, surface: &mut Surface<'_>)

Draw this widget into surface, filling surface.area().

impl<'a> Copy for StatBar<'a>