haze/dev.chrisbanes.haze/HazeChildNode

HazeChildNode

class HazeChildNode(var state: HazeState, style: HazeStyle = HazeStyle.Unspecified, var block: HazeChildScope.() -> Unit? = null) : Modifier.Node, CompositionLocalConsumerModifierNode, GlobalPositionAwareModifierNode, ObserverModifierNode, DrawModifierNode, HazeChildScope

The Modifier.Node implementation used by Modifier.hazeChild.

This is public API in order to aid custom extensible modifiers, but we reserve the right to be able to change the API in the future, hence why it is marked as experimental forever.

Constructors

constructor(state: HazeState, style: HazeStyle = HazeStyle.Unspecified, block: HazeChildScope.() -> Unit? = null)

Properties

open override var alpha: Float

The opacity that the overall effect will drawn with, in the range of 0..1.

backgroundColor

open override var 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.

var block: HazeChildScope.() -> Unit?

open override var blurRadius: Dp

Radius of the blur.

val coroutineScope: CoroutineScope

open override var fallbackTint: HazeTint

The HazeTint to use when Haze uses the fallback scrim functionality.

var isAttached: Boolean

open override var mask: Brush?

Optional alpha mask which allows effects such as fading via a Brush.verticalGradient or similar. This is only applied when progressive is null.

override var node: Modifier.Node

open override var noiseFactor: Float

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

open override var progressive: HazeProgressive?

Parameters for enabling a progressive (or gradient) blur effect, or null for a uniform blurring effect. Defaults to null.

shouldAutoInvalidate

open override val shouldAutoInvalidate: Boolean = false

var state: HazeState

open override var style: HazeStyle

Style set on this specific HazeChildNode.

open override var tints: List<HazeTint>

The HazeTints to apply to the blurred content.

Functions

open override fun ContentDrawScope.draw()

open override fun onAttach()

open fun onDetach()

onGloballyPositioned

open override fun onGloballyPositioned(coordinates: LayoutCoordinates)

onMeasureResultChanged

open fun onMeasureResultChanged()

onObservedReadsChanged

open override fun onObservedReadsChanged()

open fun onReset()

fun sideEffect(effect: () -> Unit)