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. GlassCard, 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

Constructors

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

Properties

child → Widget
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
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