LayerRasterizerHost class

Hosts the layers a LayerRasterizer is capturing.

Mount this above anything that captures — typically once around the whole app — and pass the same rasterizer to LayerRasterizer.capture:

MaterialApp(
  builder: (context, child) => LayerRasterizerHost(
    rasterizer: rasterizer,
    child: child!,
  ),
);

While idle the host adds a Stack around child and nothing else. During a capture it renders the requested layers behind child: they have to be painted for their repaint boundaries to hold an image, but child covers them so they never reach the user. This mirrors how the editor's own screenshot capture stays invisible — which also means child has to be opaque and cover the host, otherwise the layers show through for the two frames a capture takes.

Inheritance

Constructors

LayerRasterizerHost({Key? key, required LayerRasterizer rasterizer, required Widget child})
Creates a host that renders whatever rasterizer is capturing.
const

Properties

child Widget
The regular application content, painted over any captured layers.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
rasterizer LayerRasterizer
The rasterizer whose captures this host renders.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<LayerRasterizerHost>
Creates the mutable state for this widget at a given location in the tree.
override
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