haze/dev.chrisbanes.haze/HazeProgressive/LinearGradient

LinearGradient

data class LinearGradient(val easing: Easing = EaseIn, val start: Offset = Offset.Zero, val startIntensity: Float = 0.0f, val end: Offset = Offset.Infinite, val endIntensity: Float = 1.0f, val preferPerformance: Boolean = false) : HazeProgressive

A linear gradient effect.

You may wish to use the convenience builder functions provided in horizontalGradient and verticalGradient for more common use cases.

The preferPerformance flag below can be set to tell Haze how to handle the progressive effect in certain situations:

On certain platforms (Android SDK 32), drawing the progressive effect is inefficient. When preferPerformance is set to true, Haze will use a mask when running on those platforms, which is far more performant.

Parameters

easing

The easing function to use when applying the effect. Defaults to a linear easing effect.

start

Starting position of the gradient. Defaults to Offset.Zero which represents the top-left of the drawing area.

startIntensity

The intensity of the haze effect at the start, in the range 0f..1f.

end

Ending position of the gradient. Defaults to Offset.Infinite which represents the bottom-right of the drawing area.

endIntensity

The intensity of the haze effect at the end, in the range 0f..1f

preferPerformance

Whether Haze should prefer performance (when true), or quality (when false). See above for more information.

Constructors

LinearGradient

constructor(easing: Easing = EaseIn, start: Offset = Offset.Zero, startIntensity: Float = 0.0f, end: Offset = Offset.Infinite, endIntensity: Float = 1.0f, preferPerformance: Boolean = false)

Properties

easing

val easing: Easing

end

val end: Offset

endIntensity

val endIntensity: Float = 1.0f

preferPerformance

val preferPerformance: Boolean = false

start

val start: Offset

startIntensity

val startIntensity: Float = 0.0f