bn::bg_palettes namespace

Background color palettes related functions.

Contents

Functions

auto used_colors_count() -> int
Returns the number of used background colors.
auto available_colors_count() -> int
Returns the number of available background colors.
auto transparent_color() -> const optional<color>&
Returns the overridden transparent color of the backgrounds if any, bn::nullopt otherwise.
void set_transparent_color(color transparent_color)
Sets the overridden transparent color of the backgrounds.
void set_transparent_color(const optional<color>& transparent_color)
Sets or removes the overridden transparent color of the backgrounds.
void remove_transparent_color()
Removes the overridden transparent color of the backgrounds, if any.
auto brightness() -> fixed
Returns the brightness of all background color palettes.
void set_brightness(fixed brightness)
Sets the brightness of all background color palettes.
auto contrast() -> fixed
Returns the contrast of all background color palettes.
void set_contrast(fixed contrast)
Sets the contrast of all background color palettes.
auto intensity() -> fixed
Returns the intensity of all background color palettes.
void set_intensity(fixed intensity)
Sets the intensity of all background color palettes.
auto inverted() -> bool
Indicates if the colors of all background color palettes are inverted or not.
void set_inverted(bool inverted)
Sets if the colors of all background color palettes must be inverted or not.
auto grayscale_intensity() -> fixed
Returns the intensity of the grayscale effect applied to all background color palettes.
void set_grayscale_intensity(fixed intensity)
Sets the intensity of the grayscale effect applied to all background color palettes.
auto fade_color() -> color
Returns the color of the fade effect applied to all background color palettes.
auto fade_intensity() -> fixed
Returns the intensity of the fade effect applied to all background color palettes.
void set_fade_color(color color)
Sets the color of the fade effect applied to all background color palettes.
void set_fade_intensity(fixed intensity)
Sets the intensity of the fade effect applied to all background color palettes.
void set_fade(color color, fixed intensity)
Sets the color and the intensity of the fade effect applied to all background color palettes.
void log_status()
Logs the current status of the background color palettes manager.

Function documentation

void bn::bg_palettes::set_brightness(fixed brightness)

Sets the brightness of all background color palettes.

Parameters
brightness New brightness in the range [0..1].

void bn::bg_palettes::set_contrast(fixed contrast)

Sets the contrast of all background color palettes.

Parameters
contrast New contrast in the range [0..1].

void bn::bg_palettes::set_intensity(fixed intensity)

Sets the intensity of all background color palettes.

Parameters
intensity New intensity in the range [0..1].

void bn::bg_palettes::set_grayscale_intensity(fixed intensity)

Sets the intensity of the grayscale effect applied to all background color palettes.

Parameters
intensity New intensity in the range [0..1].

void bn::bg_palettes::set_fade_intensity(fixed intensity)

Sets the intensity of the fade effect applied to all background color palettes.

Parameters
intensity New intensity in the range [0..1].

void bn::bg_palettes::set_fade(color color, fixed intensity)

Sets the color and the intensity of the fade effect applied to all background color palettes.

Parameters
color New color.
intensity New intensity in the range [0..1].