BlurVisualEffect
A VisualEffect implementation that applies blur effects to content.
This effect supports various blur-related features including:
Configurable blur radius
Tinting with multiple colors
Progressive (gradient) blur
Noise overlays
Background color
Alpha masking
Example usage:
Modifier.hazeEffect { scope ->
scope.visualEffect = BlurVisualEffect().apply {
blurRadius = 20.dp
tints = listOf(HazeTint(Color.Black.copy(alpha = 0.5f)))
}
}Properties
Color to draw behind the blurred content. Ideally should be opaque so that the original content is not visible behind. Typically this would be MaterialTheme.colorScheme.surface or similar.
Whether the blur effect is enabled or not, when running on platforms which support blurring.
Radius of the blur.
The BlurredEdgeTreatment to use when blurring content.
The HazeTints to apply to the blurred content.
The HazeTint to use when Haze uses the fallback scrim functionality.
Optional alpha mask which allows effects such as fading via a Brush.verticalGradient or similar. This is only applied when progressive is null.
Amount of noise applied to the content, in the range 0f to 1f. Anything outside of that range will be clamped.
Parameters for enabling a progressive (or gradient) blur effect, or null for a uniform blurring effect. Defaults to null.
Style set on this specific blur effect.