coil-compose-core/coil3.compose/CrossfadePainter

CrossfadePainter

class CrossfadePainter(start: Painter?, val end: Painter?, val contentScale: ContentScale = ContentScale.Fit, val duration: Duration = 200.milliseconds, val timeSource: TimeSource = TimeSource.Monotonic, val fadeStart: Boolean = true, val preferExactIntrinsicSize: Boolean = false, val preferEndFirstIntrinsicSize: Boolean = false) : Painter

A Painter that crossfades from start to end.

NOTE: The animation can only be executed once as the start painter is dereferenced at the end of the transition.

Parameters

start

The Painter to crossfade from.

end

The Painter to crossfade to.

contentScale

The scaling algorithm for start and end.

duration

The duration of the crossfade animation.

timeSource

The source for measuring time intervals.

fadeStart

If false, the start drawable will not fade out while the end drawable fades in.

preferExactIntrinsicSize

If true, this drawable's intrinsic width/height will only be -1 if start and end return -1 for that dimension. If false, the intrinsic width/height will be -1 if start or end return -1 for that dimension. This is useful for views that require an exact intrinsic size to scale the drawable.

preferEndFirstIntrinsicSize

Returns true if this request prefers the end painter's intrinsic size when calculating the CrossfadePainter's intrinsic size. When enabled, the end painter's intrinsic size takes precedence.

Constructors

CrossfadePainter

constructor(start: Painter?, end: Painter?, contentScale: ContentScale = ContentScale.Fit, duration: Duration = 200.milliseconds, timeSource: TimeSource = TimeSource.Monotonic, fadeStart: Boolean = true, preferExactIntrinsicSize: Boolean = false, preferEndFirstIntrinsicSize: Boolean = false)