haze/dev.chrisbanes.haze/HazeStyle

HazeStyle

@Immutable
data class HazeStyle(val backgroundColor: Color = Color.Unspecified, val tints: List<HazeTint> = emptyList(), val blurRadius: Dp = Dp.Unspecified, val noiseFactor: Float = -1f, val fallbackTint: HazeTint = HazeTint.Unspecified)

A holder for the style properties used by Haze.

Can be set via haze and hazeChild.

Constructors

Link copied to clipboard
constructor(backgroundColor: Color = Color.Unspecified, tint: HazeTint? = null, blurRadius: Dp = Dp.Unspecified, noiseFactor: Float = -1f, fallbackTint: HazeTint = HazeTint.Unspecified)
constructor(backgroundColor: Color = Color.Unspecified, tints: List<HazeTint> = emptyList(), blurRadius: Dp = Dp.Unspecified, noiseFactor: Float = -1f, fallbackTint: HazeTint = HazeTint.Unspecified)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val backgroundColor: Color

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.

Link copied to clipboard
val blurRadius: Dp

Radius of the blur.

Link copied to clipboard
val fallbackTint: HazeTint

The HazeTint to use when Haze uses the fallback scrim functionality. In this scenario, the tints provided in tints are ignored.

Link copied to clipboard
val noiseFactor: Float

Amount of noise applied to the content, in the range 0f to 1f. Anything outside of that range will be clamped.

Link copied to clipboard
val tints: List<HazeTint>

The HazeTints to apply to the blurred content.