color_math.h

Go to the documentation of this file.

 
#ifndef COLOR_MATH_H
#define COLOR_MATH_H
 
#include <ui/qt/utils/theme_manager.h>
 
#include <QColor>

class ColorMath
{
public:
    // ---------------------------------------------------------------
    // Luminance & contrast
    // ---------------------------------------------------------------

    static double relativeLuminance(const QColor &color);

    static qreal contrastRatio(const QColor &color1, const QColor &color2);

    static QColor ensureContrast(const QColor &c, const QColor &bg, qreal minRatio);

    static bool isDark(const QColor &color);

    static constexpr qreal DistinctSurfaceRatio = 1.5;

    static constexpr qreal ReadableTextRatio = 4.5;

    static QColor selectionHoverFill(const QColor &base, const QColor &selection);

    static QColor readableText(const QColor &text, const QColor &surface);

    static bool isReadable(const QColor &text, const QColor &surface);
 
    // ---------------------------------------------------------------
    // Mix / shade
    // ---------------------------------------------------------------

    static QColor         mix(const QColor &a, const QColor &b, qreal ratio = 0.5);
    static ThemeColorPair mix(const ThemeColorPair &a, const ThemeColorPair &b, qreal ratio = 0.5);

    static QColor         darken(const QColor &c, int percent);
    static ThemeColorPair darken(const ThemeColorPair &p, int percent);

    static QColor         lighten(const QColor &c, int percent);
    static ThemeColorPair lighten(const ThemeColorPair &p, int percent);
 
    // ---------------------------------------------------------------
    // Alpha
    // ---------------------------------------------------------------

    static QColor         withAlpha(const QColor &c, int alpha);
    static ThemeColorPair withAlpha(const ThemeColorPair &p, int alpha);

    static QColor         withAlphaF(const QColor &c, qreal alpha);
    static ThemeColorPair withAlphaF(const ThemeColorPair &p, qreal alpha);
 
    // ---------------------------------------------------------------
    // Contrast & state
    // ---------------------------------------------------------------

    static QColor         contrastingText(const QColor &surface);
    static ThemeColorPair contrastingText(const ThemeColorPair &pair);

    static QColor         contrastingTextOver(const QColor &surface, const QColor &backdrop);

    static QColor         disabled(const QColor &c, const QColor &background);
    static ThemeColorPair disabled(const ThemeColorPair &p, const QColor &background);

    static QColor         hoverBg(const QColor &c, const QColor &background);
    static ThemeColorPair hoverBg(const ThemeColorPair &p, const QColor &background);
};
 
#endif /* COLOR_MATH_H */