GlassBackgroundSource class

Marks a widget as the texture capture source for the nearest LiquidGlassScope.

Wraps child in a RepaintBoundary tagged with the scope's GlobalKey. Descendant GlassEffect widgets (e.g. GlassContainer.card, GlassSegmentedControl) will sample this boundary every frame to produce real background colour absorption on Skia and Web paths, simulating true physical glass.

On Impeller with GlassQuality.premium, this is not needed — the native scene graph handles color absorption and refraction without a captured boundary.

If enabled is false, the widget will not inject a RepaintBoundary and will simply return its child, allowing GlassAdaptiveScope to disable sampling gracefully during high GPU load.

Typically you do not use this directly. Use GlassPage at the root of your route.

GlassPage(
  background: Image.asset('wallpaper.jpg', fit: BoxFit.cover),
  child: Scaffold(...),
)

Or manually, for granular control:

GlassBackgroundSource(
  enabled: true,
  child: Image.asset('wallpaper.jpg'),
)
Inheritance
Available extensions

Constructors

GlassBackgroundSource({required Widget child, bool enabled = true, Key? key})
Creates a new GlassBackgroundSource.
const

Properties

child → Widget
The child widget to display.
final
enabled → bool
Whether the background should be captured into a texture. If false, glass surfaces will fall back to a synthetic frosted tint.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
glassContextMenu({Key? key, required List<Widget> actions, WidgetBuilder? previewBuilder, bool enabled = true, bool enableHaptics = true, double borderRadius = 32.0, double? previewBorderRadius, double rowBorderRadius = 16.0, BorderRadius? rowCorners, Color? originSlotColor, Color? backgroundColor, LiquidGlassSettings? settings, GlassQuality? quality, double backdropBlur = 0.0, Color? barrierColor, double menuWidth = 250.0, VoidCallback? onOpened, VoidCallback? onDismissed, Duration longPressDuration = const Duration(milliseconds: 700)}) → Widget

Available on Widget, provided by the GlassContextMenuExtension extension

Wraps this widget in a GlassContextMenu displaying actions on long-press or right-click.
glassFullScreenCover({required bool isPresented, VoidCallback? onDismiss, required WidgetBuilder content, bool enableSwipeToDismiss = true, double dismissThreshold = 140.0, LiquidGlassSettings? settings, GlassQuality? quality}) → Widget

Available on Widget, provided by the GlassFullScreenCoverExtension extension

Presents a full-viewport modal cover whenever isPresented is true.

Available on Widget, provided by the GlassNavigationTitleExtension extension

Annotates this widget with a navigation title that drives enclosing or descendant GlassAppBar / GlassAppBar.pinned bars (when their explicit title is null) as well as header accessibility semantics.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited