haze-blur/dev.chrisbanes.haze.blur/HazeBlurStyle

HazeBlurStyle

class HazeBlurStyle(val backgroundColor: Color = Color.Unspecified, colorEffects: List<HazeColorEffect>? = null, val blurRadius: Dp = Dp.Unspecified, val noiseFactor: Float = -1f, val fallbackColorEffect: HazeColorEffect = HazeColorEffect.Unspecified)

A holder for the style properties used by Haze.

Can be set via dev.chrisbanes.haze.hazeSource and dev.chrisbanes.haze.hazeEffect.

Constructors

HazeBlurStyle

constructor(backgroundColor: Color = Color.Unspecified, colorEffects: List<HazeColorEffect>? = null, blurRadius: Dp = Dp.Unspecified, noiseFactor: Float = -1f, fallbackColorEffect: HazeColorEffect = HazeColorEffect.Unspecified)

constructor(backgroundColor: Color = Color.Unspecified, colorEffect: HazeColorEffect? = null, blurRadius: Dp = Dp.Unspecified, noiseFactor: Float = -1f, fallbackColorEffect: HazeColorEffect = HazeColorEffect.Unspecified)

Types

Companion

object Companion

Properties

backgroundColor

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.

blurRadius

val blurRadius: Dp

Radius of the blur.

colorEffects

val colorEffects: List<HazeColorEffect>

The HazeTints to apply to the blurred content.

fallbackColorEffect

val fallbackColorEffect: HazeColorEffect

The HazeTint to use when Haze uses the fallback scrim functionality. The scrim used whenever blurring is disabled, either because the host platform does not support blurring, or it has been manually disabled. When the fallback tint is used, the tints provided in colorEffects are ignored.

noiseFactor

val noiseFactor: Float

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

Functions

component1

operator fun component1(): Color

component2

operator fun component2(): List<HazeColorEffect>

component3

operator fun component3(): Dp

component4

operator fun component4(): Float

component5

operator fun component5(): HazeColorEffect

copy

fun copy(backgroundColor: Color = this.backgroundColor, colorEffects: List<HazeColorEffect>? = this.specifiedColorEffects, blurRadius: Dp = this.blurRadius, noiseFactor: Float = this.noiseFactor, fallbackColorEffect: HazeColorEffect = this.fallbackColorEffect): HazeBlurStyle

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String