Custom Colors #

Introduction #

The color class is used to define and modify colors for drawing shapes and displaying text on the V5 Brain Screen. Colors can be created using RGB values, hexadecimal color codes, HSV values, or predefined color constants.

Class Constructors #

1 — Creates a color object with no assigned color.
color();

2 — Creates a color object from a hexadecimal or integer value.
color( 
  int value );

3 — Creates a color object from RGB values.
color( 
  uint8_t r, 
  uint8_t g, 
  uint8_t b );

Class Destructor #

Destroys the color object and releases associated resources.

~color();

Parameters #

Parameter	Type	Description
`value`	`int`	The color value, which can be either a hexadecimal RGB integer (for example, `0xFFF700`) or one of the predefined color constants listed below.
`r`	`uint8_t`	An integer from 0 to 255 representing the red component.
`g`	`uint8_t`	An integer from 0 to 255 representing the green component.
`b`	`uint8_t`	An integer from 0 to 255 representing the blue component.

Notes #

The following predefined color constants are supported:
- black
- blue
- blue_green
- blue_violet
- cyan
- green
- orange
- purple
- red
- red_orange
- red_violet
- transparent
- violet
- white
- yellow
- yellow_green
- yellow_orange

Example #

// Create the color yellow using a hexadecimal value
color myYellow = color(0xFFF700);

// Create a color using RGB values
color myBlue = color(0, 100, 255);

// Create a color using a predefined constant
color myRed = color(red);

Member Functions #

The color class includes the following member functions:

rgb — Updates the color using RGB values.
hsv — Updates the color using HSV values.
web — Updates the color using a web hex color string.

Before calling any color member functions, a color instance must be created, as shown below:

// Create a color using RGB values
color brainColor = color(255, 128, 0);

rgb #

Updates the color of an existing color object using RGB values.

Available Functions

1 — Updates a color object with a packed RGB value.
uint32_t rgb( 
  uint32_t value );

2 — Updates a color object with separate RGB values.
uint32_t rgb( 
  uint8_t r, 
  uint8_t g, 
  uint8_t b );

Parameters

Parameter	Type	Description
`value`	`uint32_t`	A packed RGB value containing all three color components.
`r`	`uint8_t`	An integer from 0 to 255 representing the red component of the color.
`g`	`uint8_t`	An integer from 0 to 255 representing the green component of the color.
`b`	`uint8_t`	An integer from 0 to 255 representing the blue component of the color.

Return Values

Returns a uint32_t representing the packed RGB value of the updated color.

Examples

// Draw a rectangle with a custom teal color
color brainColor = color(50, 200, 180);
Brain.Screen.setFillColor(brainColor);
Brain.Screen.drawRectangle(0, 0, 480, 120);

// Change the color to magenta for a second rectangle
brainColor.rgb(170, 40, 150);

Brain.Screen.setFillColor(brainColor);
Brain.Screen.drawRectangle(0, 120, 480, 120);

hsv #

Updates the color of an existing color object using hue, saturation, and brightness values.

Available Functions

hsv( 
  uint32_t hue, 
  double   sat, 
  double   value );

Parameters

Parameter	Type	Description
`hue`	`uint32_t`	An integer from 0 to 360 that represents the hue of the color.
`sat`	`double`	A double from 0.0 to 1.0 that represents the saturation of the color.
`value`	`double`	A double from 0.0 to 1.0 that represents the brightness of the color.

Return Values

Returns a reference to the updated color object.

Examples

// Draw a rectangle with a custom teal color
color brainColor = color(50, 200, 180);
Brain.Screen.setFillColor(brainColor);
Brain.Screen.drawRectangle(0, 0, 480, 120);

// Change the color to magenta for a second rectangle
brainColor.hsv(300, 0.75, 0.78);

Brain.Screen.setFillColor(brainColor);
Brain.Screen.drawRectangle(0, 120, 480, 120);

web #

Updates the color of an existing color object using a hexadecimal or web color value.

Available Functions

web( 
  const char* color );

Parameters

Parameter	Type	Description
`color`	`const char*`	A hexadecimal or web color value that defines a specific color (e.g., `“#FF0000”` for red).

Return Values

Returns a reference to the updated color object.

Examples

// Draw a rectangle with a custom teal color
color brainColor = color(50, 200, 180);
Brain.Screen.setFillColor(brainColor);
Brain.Screen.drawRectangle(0, 0, 480, 120);

// Change the color to magenta for a second rectangle
brainColor.web("#AA2896");

Brain.Screen.setFillColor(brainColor);
Brain.Screen.drawRectangle(0, 120, 480, 120);