openrndr-color/org.openrndr.color/ColorHSLa

ColorHSLa

@Serializable
@JvmRecord
data class ColorHSLa(val h: Double, val s: Double, val l: Double, val alpha: Double = 1.0) : ColorModel<ColorHSLa> , ShadableColor<ColorHSLa> , HueShiftableColor<ColorHSLa> , SaturatableColor<ColorHSLa> , AlgebraicColor<ColorHSLa> (source)

The HSL color space.

Parameters

h

hue in degrees, where a full rotation is 360.0 degrees

s

saturation as a percentage between 0.0 and 1.0

l

lightness/luminance as a percentage between 0.0 and 1.0

alpha

alpha as a percentage between 0.0 and 1.0

See also

Constructors

Link copied to clipboard
constructor(h: Double, s: Double, l: Double, alpha: Double = 1.0)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val alpha: Double = 1.0
Link copied to clipboard
val h: Double
Link copied to clipboard
open override val hue: Double
Link copied to clipboard
val l: Double
Link copied to clipboard
val s: Double
Link copied to clipboard
open override val saturation: Double
Link copied to clipboard

Functions

Link copied to clipboard
open operator override fun div(scale: Double): ColorHSLa
Link copied to clipboard
open operator override fun minus(right: ColorHSLa): ColorHSLa
Link copied to clipboard
open override fun mix(other: ColorHSLa, factor: Double): ColorHSLa
Link copied to clipboard
open fun mixHue(hue: Double, factor: Double): ColorHSLa
Link copied to clipboard
open fun mixSaturation(saturation: Double, factor: Double): ColorHSLa
Link copied to clipboard
open override fun opacify(factor: Double): ColorHSLa

Returns a copy of the color with the opacity (alpha) multiplied by a factor.

Link copied to clipboard
open operator override fun plus(right: ColorHSLa): ColorHSLa
Link copied to clipboard
open fun saturate(factor: Double): ColorHSLa

Multiply the saturation by a factor.

Link copied to clipboard
open override fun shade(factor: Double): ColorHSLa

Multiply the shade by a factor.

Link copied to clipboard
open fun shiftHue(shiftInDegrees: Double): ColorHSLa

Shift the hue of a color by the given amount of degrees.

Link copied to clipboard
open operator override fun times(scale: Double): ColorHSLa
Link copied to clipboard
fun toHSVa(): ColorHSVa
Link copied to clipboard
fun toLABa(ref: ColorXYZa = ColorXYZa.NEUTRAL): ColorLABa
Link copied to clipboard
fun toLCHABa(ref: ColorXYZa = ColorXYZa.NEUTRAL): ColorLCHABa
Link copied to clipboard
fun toLCHUVa(ref: ColorXYZa = ColorXYZa.NEUTRAL): ColorLCHUVa
Link copied to clipboard
fun toLUVa(ref: ColorXYZa = ColorXYZa.NEUTRAL): ColorLUVa
Link copied to clipboard
open override fun toRGBa(): ColorRGBa

Convert into ColorRGBa.

Link copied to clipboard
open override fun toVector4(): Vector4
Link copied to clipboard
fun toXSLa(): ColorXSLa

convert to ColorXSLa

Link copied to clipboard
fun toXYZa(): ColorXYZa
Link copied to clipboard
open override fun withHue(hue: Double): ColorHSLa
Link copied to clipboard
open override fun withSaturation(saturation: Double): ColorHSLa