HslAdjustment.Builder

class HslAdjustment.Builder

A builder for HslAdjustment instances.

Summary

Public constructors

Creates a new instance with the default values.

Public functions
HslAdjustment.Builder!
@CanIgnoreReturnValue
adjustHue(hueAdjustmentDegrees: Float)

Rotates the hue of the frame by hueAdjustmentDegrees.
HslAdjustment.Builder!
@CanIgnoreReturnValue
adjustLightness(
    lightnessAdjustment: @FloatRange(from = "-100", to = 100) Float
)

Adjusts the lightness of the frame by lightnessAdjustment.
HslAdjustment.Builder!
@CanIgnoreReturnValue
adjustSaturation(
    saturationAdjustment: @FloatRange(from = "-100", to = 100) Float
)

Adjusts the saturation of the frame by saturationAdjustment.
HslAdjustment!

Creates a new HslAdjustment instance.

Public constructors

Builder

Builder()

Creates a new instance with the default values.

Public functions

adjustHue

@CanIgnoreReturnValue
fun adjustHue(hueAdjustmentDegrees: Float): HslAdjustment.Builder!

Rotates the hue of the frame by hueAdjustmentDegrees.

The Hue of the frame is defined in the interval of [0, 360] degrees. The actual degrees of hue adjustment applied is hueAdjustmentDegrees % 360.

Parameters
hueAdjustmentDegrees: Float

The hue adjustment in rotation degrees. The default value is 0, which means no change is applied.

adjustLightness

@CanIgnoreReturnValue
fun adjustLightness(
    lightnessAdjustment: @FloatRange(from = "-100", to = 100) Float
): HslAdjustment.Builder!

Adjusts the lightness of the frame by lightnessAdjustment.

Lightness is defined in the interval of [0, 100] where a lightness of 0 is a black frame and a lightness of 100 is a white frame.

Parameters
lightnessAdjustment: @FloatRange(from = "-100", to = 100) Float

The difference by how much the lightness will be adjusted in either direction. Needs to be in the interval of [-100, 100] and the default value is 0, which means no change is applied.

adjustSaturation

@CanIgnoreReturnValue
fun adjustSaturation(
    saturationAdjustment: @FloatRange(from = "-100", to = 100) Float
): HslAdjustment.Builder!

Adjusts the saturation of the frame by saturationAdjustment.

Saturation is defined in the interval of [0, 100] where a saturation of 0 will generate a grayscale frame and a saturation of 100 has a maximum separation between the colors.

Parameters
saturationAdjustment: @FloatRange(from = "-100", to = 100) Float

The difference of how much the saturation will be adjusted in either direction. Needs to be in the interval of [-100, 100] and the default value is 0, which means no change is applied.

build

fun build(): HslAdjustment!

Creates a new HslAdjustment instance.