haze-glass/dev.chrisbanes.haze.glass

Package-level declarations

Types

enum ChromaticAberrationMode : Enum<ChromaticAberrationMode>

Controls the quality and appearance of chromatic aberration (color dispersion) at the refraction edges.

data class GlassAccessibilitySettings(val reduceTransparency: Boolean = false, val increaseContrast: Boolean = false, val showBorders: Boolean = false)

Semantic accessibility preferences that change how Glass separates itself from its content.

GlassDefaults

object GlassDefaults

Light-calibrated default values used by hazeGlass and GlassStyle resolution.

GlassInteractionScope

sealed interface GlassInteractionScope

Declares the visual response for one Glass interaction state.

GlassOptics

@Immutable

data class GlassOptics(val refractionStrength: Float = 0.7f, val refractionHeightFraction: Float = 0.25f, val refractionDisplacement: Dp = 15.dp, val depth: OpticalSizeValue<Float> = OpticalSizeValue.Fixed(1f), val blurRadius: OpticalSizeValue<Dp> = OpticalSizeValue.Fixed(14.dp), val progressive: HazeProgressive? = null, val refractionFoldStrength: Float = 0.0f, val refractionDetailIntensity: Float = 0.76f, val refractionProfile: RefractionProfile = RefractionProfile.Surface)

The optical response used to render a Glass material.

GlassReducedMotionPolicy

enum GlassReducedMotionPolicy : Enum<GlassReducedMotionPolicy>

Controls whether interaction motion is reduced.

GlassStyle

@Immutable

sealed interface GlassStyle

An opaque, immutable sequence of Glass appearance writes.

GlassStyleDsl

@DslMarker

annotation class GlassStyleDsl

Marks the nested receiver scopes used while constructing a GlassStyle.

GlassStyleScope

class GlassStyleScope

Receiver for Glass appearance property writes.

GlassTransformPivot

enum GlassTransformPivot : Enum<GlassTransformPivot>

Selects the pivot used by the interaction scale transform.

GlassTransformTarget

enum GlassTransformTarget : Enum<GlassTransformTarget>

Selects which visual layers receive the interaction scale transform.

OpticalSizePoint

data class OpticalSizePoint<T>(val shortestDimension: Dp, val value: T)

Associates a value with a positive shortest dimension.

OpticalSizeValue

sealed interface OpticalSizeValue<T>

An optical parameter value that is either fixed or responsive to a material's shortest dimension.

RefractionProfile

@Immutable

sealed interface RefractionProfile

Controls how refraction displaces content independently of the material's lighting.

SurfaceProfile

enum SurfaceProfile : Enum<SurfaceProfile>

Describes the cross-sectional surface shape of the Glass bezel.

Properties

LocalGlassAccessibilitySettings

val LocalGlassAccessibilitySettings: ProvidableCompositionLocal<GlassAccessibilitySettings>

Accessibility preferences inherited by Glass nodes in this composition subtree.

LocalGlassStyle

val LocalGlassStyle: ProvidableCompositionLocal<GlassStyle>

A ProvidableCompositionLocal which provides inherited Glass appearance.

Functions

GlassStyle

fun GlassStyle(block: GlassStyleScope.() -> Unit): GlassStyle

Creates a recorded, replayable GlassStyle.

hazeGlass

@Stable

fun Modifier.hazeGlass(input: HazeInput, style: GlassStyle = GlassStyle, performanceMode: HazePerformanceMode? = null, expandLayerBounds: Boolean = true, interactionSource: InteractionSource? = null, interactionTransformTarget: GlassTransformTarget = GlassTransformTarget.MaterialOnly, interactionTransformPivot: GlassTransformPivot = GlassTransformPivot.Pointer, interactionReducedMotionPolicy: GlassReducedMotionPolicy = GlassReducedMotionPolicy.System): Modifier

Draws a Glass material using an explicit Haze input.