MaxOS::common::Colour Class Reference

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...

#include <colour.h>

Public Member Functions
	Colour (ConsoleColour colour)
	Constructs a Colour from the the console equivalent.
	Colour (string string)
	Constructs a Colour from a string. If it starts with a '#' will be treated as a hex code otherwise, a ansi code.
	Colour (uint8_t red, uint8_t green, uint8_t blue)
	Constructs a Colour from a set of RGB values. Alpha defaults to 255.
	Colour (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha)
	Constructs a Colour from a set of RGBA values.
ConsoleColour	to_console_colour () const
	Converts the colour to a console colour.

Public Attributes
uint8_t	red { 0 }
	The amount of red 0-255.
uint8_t	green { 0 }
	The amount of green 0-255.
uint8_t	blue { 0 }
	The amount of blue 0-255.
uint8_t	alpha { 0 }
	The amount of alpha 0-255 (0 is visible, 255 is invisible) todo: confirm.

Detailed Description

Stores the red, green, blue and alpha values of a colour. Can be parsed from a hex string, an ANSI string or a ConsoleColour.

Definition at line 91 of file colour.h.

Constructor & Destructor Documentation

Colour() [1/4]

Colour::Colour ( ConsoleColour  colour )

explicit

Constructs a Colour from the the console equivalent.

Parameters

colour

The console colour to convert

Definition at line 21 of file colour.cpp.

                                   {
    parse_console_colour(colour);
}

Colour() [2/4]

Colour::Colour ( string  string )

explicit

Constructs a Colour from a string. If it starts with a '#' will be treated as a hex code otherwise, a ansi code.

Parameters

string

The string to parse, must be either a hex code or an ANSI escape code

Definition at line 30 of file colour.cpp.

                            {
 
    if (string[0] == '#')
        parse_hex_string(string);
    else
        parse_ansi_string(string);
 
}

Colour() [3/4]

Colour::Colour	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue
	)

Constructs a Colour from a set of RGB values. Alpha defaults to 255.

Parameters

red	The amount of red 0-255
green	The amount of green 0-255
blue	The amount of blue 0-255

Definition at line 46 of file colour.cpp.

: red(red),
  green(green),
  blue(blue)
{
 
}

Colour() [4/4]

Colour::Colour	(	uint8_t	red,
		uint8_t	green,
		uint8_t	blue,
		uint8_t	alpha
	)

Constructs a Colour from a set of RGBA values.

Parameters

red	The amount of red 0-255
green	The amount of green 0-255
blue	The amount of blue 0-255
alpha	The amount of alpha 0-255

Definition at line 62 of file colour.cpp.

: red(red),
  green(green),
  blue(blue),
  alpha(alpha)
{
 
}

Member Function Documentation

to_console_colour()

ConsoleColour Colour::to_console_colour

(

)

const

Converts the colour to a console colour.

Returns

The console colour

Definition at line 261 of file colour.cpp.

                                              {
 
 
    if (red == 0 && green == 0 && blue == 0)
        return ConsoleColour::Black;
 
    if (red == 0 && green == 128 && blue == 253)
        return ConsoleColour::Blue;
 
    if (red == 0 && green == 170 && blue == 0)
        return ConsoleColour::Green;
 
    if (red == 0 && green == 170 && blue == 170)
        return ConsoleColour::Cyan;
 
    if (red == 170 && green == 0 && blue == 0)
        return ConsoleColour::Red;
 
    if (red == 170 && green == 0 && blue == 170)
        return ConsoleColour::Magenta;
 
    if (red == 170 && green == 85 && blue == 0)
        return ConsoleColour::Brown;
 
    if (red == 170 && green == 170 && blue == 170)
        return ConsoleColour::LightGrey;
 
    if (red == 85 && green == 85 && blue == 85)
        return ConsoleColour::DarkGrey;
 
    if (red == 85 && green == 85 && blue == 255)
        return ConsoleColour::LightBlue;
 
    if (red == 85 && green == 255 && blue == 85)
        return ConsoleColour::LightGreen;
 
    if (red == 85 && green == 255 && blue == 255)
        return ConsoleColour::LightCyan;
 
    if (red == 255 && green == 85 && blue == 85)
        return ConsoleColour::LightRed;
 
    if (red == 255 && green == 85 && blue == 255)
        return ConsoleColour::LightMagenta;
 
    if (red == 0x96 && green == 0x82 && blue == 0x0E)
        return ConsoleColour::Yellow;
 
    if (red == 255 && green == 255 && blue == 255)
        return ConsoleColour::White;
 
    // Return a default value in case no match is found
    return ConsoleColour::Black;
}

References blue, green, and red.

Referenced by MaxOS::drivers::console::VESABootConsole::put_character().

Member Data Documentation

alpha

uint8_t MaxOS::common::Colour::alpha { 0 }

The amount of alpha 0-255 (0 is visible, 255 is invisible) todo: confirm.

Definition at line 102 of file colour.h.

{ 0 };  

Referenced by MaxOS::common::GraphicsContext::colour_to_int().

blue

uint8_t MaxOS::common::Colour::blue { 0 }

The amount of blue 0-255.

Definition at line 101 of file colour.h.

{ 0 };  

Referenced by MaxOS::common::GraphicsContext::colour_to_int(), MaxOS::common::GraphicsContext::invert_pixel(), and to_console_colour().

green

uint8_t MaxOS::common::Colour::green { 0 }

The amount of green 0-255.

Definition at line 100 of file colour.h.

{ 0 };  

Referenced by MaxOS::common::GraphicsContext::colour_to_int(), MaxOS::common::GraphicsContext::invert_pixel(), and to_console_colour().

red

uint8_t MaxOS::common::Colour::red { 0 }

The amount of red 0-255.

Definition at line 99 of file colour.h.

{ 0 };  

Referenced by MaxOS::common::GraphicsContext::colour_to_int(), MaxOS::common::GraphicsContext::invert_pixel(), and to_console_colour().

---

The documentation for this class was generated from the following files:

• /home/runner/work/MaxOS/MaxOS/kernel/include/common/colour.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/common/colour.cpp