Struct Style 

pub struct Style { /* private fields */ }

A style consisting of foreground and background color.

No text modifiers (bold, italic, underline, etc.) by design: retroglyph is a spiritual remake of BearLibTerminal, which doesn’t support them either. A pixel/bitmap-font renderer can’t fake most of them (no bold font variant, no underline stroke) without real per-style assets, so rather than have them work in a real terminal and silently do nothing in the software backend, they’re not part of the API at all. Color and glyph choice are the only two knobs, in every backend.

Examples

use retroglyph_core::{Color, Style};

let style = Style::new().fg(Color::GREEN).bg(Color::BLACK);
assert_eq!(style.foreground(), Color::GREEN);
assert_eq!(style.background(), Color::BLACK);

Implementations

impl Style

pub fn new() -> Self

Creates a new style with default values.

pub const fn fg(self, color: Color) -> Self

Sets the foreground color, which colors the cell’s glyph.

Does not tint a sprite: on a pixel backend, a cell whose glyph resolves to a sprite is composited from the sprite’s own pixels and ignores this color entirely. The same cell drawn by a cell backend falls back to its glyph and is colored by it, so one value can read very differently across backends. See Surface::put_span.

pub const fn bg(self, color: Color) -> Self

Sets the background color.

pub const fn foreground(&self) -> Color

Returns the foreground color.

pub const fn background(&self) -> Color

Returns the background color.

pub fn patch(self, other: Self) -> Self

Overlays another style onto this one, only if fields in other are non-default.

Color::Default in other means “unset”, not “reset to default”: a field left at Color::Default is skipped, and self’s existing value for that field is kept. This mirrors ratatui’s Style::patch convention, so Style::new().fg(Color::Default) is a no-op when patched onto anything, and there is no way to use patch to explicitly clear a field back to Color::Default; use Style::reset_fg or Style::reset_bg for that.

use retroglyph_core::{Color, Style};

let base = Style::new().fg(Color::RED).bg(Color::BLUE);

// Patching with a default `fg` leaves `base`'s red foreground untouched.
let patched = base.patch(Style::new().bg(Color::GREEN));
assert_eq!(patched.foreground(), Color::RED);
assert_eq!(patched.background(), Color::GREEN);

pub const fn reset_fg(self) -> Self

Resets the foreground color to Color::Default.

Unlike Style::patch, which treats Color::Default as “leave unset”, this explicitly clears the field. Use this when a caller needs to undo a previously patched-in foreground color rather than merge in a new one.

pub const fn reset_bg(self) -> Self

Resets the background color to Color::Default.

Unlike Style::patch, which treats Color::Default as “leave unset”, this explicitly clears the field. Use this when a caller needs to undo a previously patched-in background color rather than merge in a new one.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Style

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

impl Eq for Style

impl Hash for Style

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Style

fn eq(&self, other: &Style) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Style