colour.h File Reference

Defines a Colour class for representing colours in RGBA format, along with ANSI and console colour enumerations. More...

#include <common/string.h>
#include <cstdint>

Go to the source code of this file.

Classes
class	MaxOS::common::Colour
	Stores the red, green, blue and alpha values of a colour. Can be parsed from a hex string, an ANSI string or a ConsoleColour. More...

Enumerations
enum	MaxOS::common::ANSIColour {   FG_Black , FG_Red , FG_Green , FG_Yellow ,   FG_Blue , FG_Magenta , FG_Cyan , FG_White ,   BG_Black , BG_Red , BG_Green , BG_Yellow ,   BG_Blue , BG_Magenta , BG_Cyan , BG_White ,   Reset }
	Enumeration of ANSI colour codes for foreground and background colours. More...
enum class	MaxOS::common::ConsoleColour {   Uninitialised = 0xFF , Black = 0x00 , Blue = 0x01 , Green = 0x02 ,   Cyan = 0x03 , Red = 0x04 , Magenta = 0x05 , Brown = 0x06 ,   LightGrey = 0x07 , DarkGrey = 0x08 , LightBlue = 0x09 , LightGreen = 0x0A ,   LightCyan = 0x0B , LightRed = 0x0C , LightMagenta = 0x0D , Yellow = 0x0E ,   White = 0x0F }
	Enumeration of console colour codes. More...

Variables
const char *const	MaxOS::common::ANSI_COLOURS []
	ANSI Colour Codes.

Detailed Description

Defines a Colour class for representing colours in RGBA format, along with ANSI and console colour enumerations.

Date

30th March 2023

Author

Max Tyson

Definition in file colour.h.

Enumeration Type Documentation

ANSIColour

enum MaxOS::common::ANSIColour

Enumeration of ANSI colour codes for foreground and background colours.

Definition at line 43 of file colour.h.

                    {
        FG_Black,
        FG_Red,
        FG_Green,
        FG_Yellow,
        FG_Blue,
        FG_Magenta,
        FG_Cyan,
        FG_White,
        BG_Black,
        BG_Red,
        BG_Green,
        BG_Yellow,
        BG_Blue,
        BG_Magenta,
        BG_Cyan,
        BG_White,
        Reset,
    };

ConsoleColour

enum class MaxOS::common::ConsoleColour

strong

Enumeration of console colour codes.

Definition at line 67 of file colour.h.

                             {
        Uninitialised = 0xFF,
        Black = 0x00,
        Blue = 0x01,
        Green = 0x02,
        Cyan = 0x03,
        Red = 0x04,
        Magenta = 0x05,
        Brown = 0x06,
        LightGrey = 0x07,
        DarkGrey = 0x08,
        LightBlue = 0x09,
        LightGreen = 0x0A,
        LightCyan = 0x0B,
        LightRed = 0x0C,
        LightMagenta = 0x0D,
        Yellow = 0x0E,
        White = 0x0F
    };

Variable Documentation

ANSI_COLOURS

const char* const MaxOS::common::ANSI_COLOURS[]

Initial value:

= {
            "\033[0;30m", 
            "\033[0;31m", 
            "\033[0;32m", 
            "\033[0;33m", 
            "\033[0;34m", 
            "\033[0;35m", 
            "\033[0;36m", 
            "\033[0;37m", 
            "\033[0;40m", 
            "\033[0;41m", 
            "\033[0;42m", 
            "\033[0;43m", 
            "\033[0;44m", 
            "\033[0;45m", 
            "\033[0;46m", 
            "\033[0;47m",  
            "\033[0m"     
    }

ANSI Colour Codes.

Definition at line 19 of file colour.h.

                                       {
            "\033[0;30m", // FG Black
            "\033[0;31m", // FG Red
            "\033[0;32m", // FG Green
            "\033[0;33m", // FG Yellow
            "\033[0;34m", // FG Blue
            "\033[0;35m", // FG Magenta
            "\033[0;36m", // FG Cyan
            "\033[0;37m", // FG White
            "\033[0;40m", // BG Black
            "\033[0;41m", // BG Red
            "\033[0;42m", // BG Green
            "\033[0;43m", // BG Yellow
            "\033[0;44m", // BG Blue
            "\033[0;45m", // BG Magenta
            "\033[0;46m", // BG Cyan
            "\033[0;47m",  // BG White
            "\033[0m"     // Reset
    };

Referenced by MaxOS::drivers::console::VESABootConsole::finish(), and MaxOS::Logger::set_log_level().