colormath/com.github.ajalt.colormath.model/HWB

HWB

data class HWB(val h: Float, val w: Float, val b: Float, val alpha: Float = 1.0f) : Color, HueColor

A color model represented with Hue, Whiteness, and Blackness.

This is a cylindrical representation of the sRGB space used in RGB.

Component	Description	Range
h	hue, degrees	`[0, 360)`
w	whiteness	`[0, 1]`
b	blackness	`[0, 1]`

Constructors

HWB

constructor(h: Number, w: Number, b: Number, alpha: Number = 1.0f)

constructor(h: Float, w: Float, b: Float, alpha: Float = 1.0f)

Types

Companion

object Companion : ColorSpace<HWB>

Default constructors for the HWB color model.

Properties

alpha

open override val alpha: Float = 1.0f

The opacity of this color, in the range [0, 1], or NaN if the opacity is unspecified

val b: Float

open override val h: Float

The hue, as degrees in the range [0, 360)

space

open override val space: ColorSpace<HWB>

The color space describing this color

val w: Float

Functions

clamp

open override fun clamp(): HWB

Return a copy of this color with all component values in their reference range.

convertTo

fun <T : Color> Color.convertTo(space: ColorSpace<T>): T

Convert this color to a given space.

differenceCIE2000

fun Color.differenceCIE2000(other: Color): Float

Calculate the difference ΔEab between this color and other using the CIE 2000 recommendation.

differenceCIE76

fun Color.differenceCIE76(other: Color): Float

Calculate the difference ΔEab between this color and other using the CIE 1976 recommendation.

differenceCIE94

fun Color.differenceCIE94(other: Color, textiles: Boolean = false): Float

Calculate the difference ΔEab between this color and other using the CIE 1994 recommendation.

differenceCMC

fun Color.differenceCMC(other: Color, l: Float = 2.0f, c: Float = 1.0f): Float

Calculate the difference ΔEcmc between this color and other using the Colour Measurement Committee recommendation.

differenceEz

fun Color.differenceEz(other: Color): Float

Calculate the difference ΔEz between this color and other using the JzAzBz color space.

firstWithContrast

fun Color.firstWithContrast(vararg colors: Color, targetContrast: Float): Color

Return the first color with a contrast ratio exceeding the targetContrast against this color. If no color meets the target, black or white will be returned, whichever has the most contrast.

firstWithContrastOrNull

fun Color.firstWithContrastOrNull(vararg colors: Color, targetContrast: Float): Color?

Return the first color with a contrast ratio greater or equal to the targetContrast against this color, or null if no color meets the target.

formatCssString

@JvmOverloads

fun Color.formatCssString(hueUnit: AngleUnit = AngleUnit.AUTO, renderAlpha: RenderCondition = RenderCondition.AUTO, unitsPercent: Boolean = false, alphaPercent: Boolean = false, legacyName: Boolean = false, legacyFormat: Boolean = false, customColorSpaces: Map<String, ColorSpace<*>> = emptyMap()): String

Render this color in CSS functional notation.

formatCssStringOrNull

fun Color.formatCssStringOrNull(hueUnit: AngleUnit = AngleUnit.AUTO, renderAlpha: RenderCondition = RenderCondition.AUTO, unitsPercent: Boolean = false, alphaPercent: Boolean = false, legacyName: Boolean = false, legacyFormat: Boolean = false, customColorSpaces: Map<String, ColorSpace<*>> = emptyMap()): String?

Render this color in CSS functional notation if this color space is defined in the CSS standard, or return null if this color is in another color space.

hueAsGrad

fun HueColor.hueAsGrad(): Float

Convert this color's hue to gradians (360° == 400 gradians)

hueAsRad

fun HueColor.hueAsRad(): Float

Convert this color's hue to radians (360° == 2π radians)

hueAsTurns

fun HueColor.hueAsTurns(): Float

Convert this color's hue to turns (360° == 1 turn)

hueOr