Struct game_library::progress_bar::ColorScheme

pub struct ColorScheme {
    pub background: Color,
    pub bar: BarColors,
    pub cutoffs: BarStateCutoffs,
}

The colors used in a progress bar.

Fields

background: Color

The background color of the bar. Defaults to [Color::NONE].

bar: BarColors

The color of the bar, for three different states: Ok, Moderate, and Critical.

cutoffs: BarStateCutoffs

The cutoffs for the Moderate and Critical states.

These are percentages, so they should be between 0.0 and 1.0, and the Moderate cutoff should be less than the Critical cutoff.

The default values are 0.55 and 0.2, respectively.

Implementations

impl ColorScheme

pub fn get_color_direct(&self, percentage: f32) -> Color

Get the color needed for the given percentage.

pub fn get_color<T: Percentage>(&self, percentage: &T) -> Color

Get the color needed for the given object that implements Percentage.

pub fn set_background(&mut self, color: Color)

Set the background color.

pub fn set_color(&mut self, state: &BarState, color: Color)

Set the color for the given state.

pub fn set_moderate_cutoff(&mut self, cutoff: f32)

Set the moderate cutoff.

pub fn set_critical_cutoff(&mut self, cutoff: f32)

Set the critical cutoff.

pub fn set_single_color(&mut self, color: Color)

Set the same color for all states.

pub const fn cutoffs(&self) -> &BarStateCutoffs

Get the bar cutoffs.

Trait Implementations

impl Clone for ColorScheme

fn clone(&self) -> ColorScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColorScheme

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

Formats the value using the given formatter.

impl Default for ColorScheme

fn default() -> Self

Returns the “default value” for a type.