library/xyz.malefic.kutint/KutintColor

KutintColor

sealed class KutintColor<T : ColorSpace> : CSSColorValue

Base class for all color types supported by Kutint. See RGB and HSL for specific implementations.

Includes a variety of functions for working with colors in Kobweb and Compose HTML.

Inheritors

RGB

HSL

Properties

alpha

abstract val alpha: Float

Alpha channel 0-1

hsl

abstract val hsl: HSL

An HSL representation of the current color.

rgb

abstract val rgb: RGB

An RGB representation of the current color.

Functions

blend

fun blend(other: KutintColor<*>, amount: Float = 0.5f): RGB

Blends two colors together using a linear interpolation between them in the RGB color space.

complement

fun complement(): HSL

Gets the complementary color in the HSL color space.

darken

infix fun darken(amount: Float = 0.2f): HSL

Darkens the color, through the HSL color space, by a given amount.

desaturate

infix fun desaturate(amount: Float = 0.2f): HSL

Desaturates the color, through the HSL color space, by a given amount.

grayscale

fun grayscale(): RGB

Converts the color to grayscale using the W3C formula for relative luminance through the RGB color space.

hueRotate

infix fun hueRotate(degrees: Int = 30): HSL

Rotates the hue in the HSL color space by a given number of degrees.

invert

fun invert(): RGB

Inverts the color by subtracting each channel from 255 in the RGB color space.

lighten

infix fun lighten(amount: Float = 0.2f): HSL

Lightens the color, through the HSL color space, by a given amount.

luminance

fun luminance(): Double

Calculates the luminance of the color in the RGB color space.

saturate

infix fun saturate(amount: Float = 0.2f): HSL

Saturates the color, through the HSL color space, by a given amount.

shade

infix fun shade(amount: Float = 0.2f): RGB

Shades the color, using a linear interpolation between the original color and black in the RGB color space, by a given amount.

tint

infix fun tint(amount: Float = 0.2f): RGB

Tints the color, using a linear interpolation between the original color and white in the RGB color space, by a given amount.

toHex

fun toHex(includeAlpha: Boolean = alpha < 1f): String

Converts the color to a hex string.

withAlpha

abstract infix fun withAlpha(newAlpha: Float): KutintColor<T>

Creates a new color with the given alpha value.

withHSL

inline fun <T> withHSL(func: (h: Float, s: Float, l: Float) -> T): T

Utility function for switching the HSL color space and performing an operation on the channels.

withRGB

inline fun <T> withRGB(func: (r: Float, g: Float, b: Float) -> T): T

Utility function for switching to the RGB color space and performing an operation on the channels.