Enum AnsiColor 

pub enum AnsiColor {
    Black = 0,
    Red = 1,
    Green = 2,
    Yellow = 3,
    Blue = 4,
    Magenta = 5,
    Cyan = 6,
    White = 7,
    BrightBlack = 8,
    BrightRed = 9,
    BrightGreen = 10,
    BrightYellow = 11,
    BrightBlue = 12,
    BrightMagenta = 13,
    BrightCyan = 14,
    BrightWhite = 15,
}

Standard 16-color ANSI palette.

Prefer Ansi colors when you want your game to respect the user’s terminal color theme (e.g., Solarized, Nord, or custom themes). Use Rgb for fixed colors that must appear identical regardless of the user’s terminal configuration.

Examples

use retroglyph_core::color::{AnsiColor, Color};

let color = Color::Ansi(AnsiColor::Green);
assert_eq!(AnsiColor::Green.to_index(), 2);
assert_eq!(color, Color::GREEN);

Variants

Black = 0

Black.

Red = 1

Red.

Green = 2

Green.

Yellow = 3

Yellow.

Blue = 4

Blue.

Magenta = 5

Magenta.

Cyan = 6

Cyan.

White = 7

White.

BrightBlack = 8

Bright Black.

BrightRed = 9

Bright Red.

BrightGreen = 10

Bright Green.

BrightYellow = 11

Bright Yellow.

BrightBlue = 12

Bright Blue.

BrightMagenta = 13

Bright Magenta.

BrightCyan = 14

Bright Cyan.

BrightWhite = 15

Bright White.

Implementations

impl AnsiColor

pub const fn to_index(self) -> u8

Returns the ANSI color code as a u8 index.

pub const fn to_rgb(self) -> (u8, u8, u8)

Returns the standard xterm RGB values for this ANSI color.

These are the classic xterm defaults, the same 16 reference colors used by Color::to_indexed and Color::to_ansi when quantizing RGB input. xterm’s own defaults have shifted across versions, and a terminal’s actual theme may render these colors differently still.

Trait Implementations

impl Clone for AnsiColor

fn clone(&self) -> AnsiColor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AnsiColor

impl Debug for AnsiColor

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

Formats the value using the given formatter.

impl Default for AnsiColor

fn default() -> AnsiColor

Returns the “default value” for a type.

impl Eq for AnsiColor

impl Hash for AnsiColor

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

where __H: Hasher,

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 AnsiColor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AnsiColor

impl TryFrom<u8> for AnsiColor

type Error = InvalidAnsiIndex

The type returned in the event of a conversion error.

fn try_from(v: u8) -> Result<AnsiColor, <AnsiColor as TryFrom<u8>>::Error>

Performs the conversion.