SurfaceBarrierPainter class

Custom painter that creates a barrier effect with an optional cutout.

Paints a large colored rectangle that covers the entire screen, with an optional rounded rectangle cutout to create a "spotlight" effect around modal content. Uses path clipping to create the cutout area.

Features:

Full-screen barrier painting
Rounded rectangle cutouts
Configurable colors and padding
Efficient repainting optimization

Example:

CustomPaint(
  painter: SurfaceBarrierPainter(
    clip: true,
    borderRadius: BorderRadius.circular(8),
    barrierColor: Colors.black54,
    padding: EdgeInsets.all(16),
  ),
)

Inheritance

Object
Listenable
CustomPainter
SurfaceBarrierPainter

Constructors

SurfaceBarrierPainter.new({required bool clip, required BorderRadius borderRadius, required Color barrierColor, EdgeInsets padding = EdgeInsets.zero}): Creates a SurfaceBarrierPainter.

Properties

barrierColor → Color: Color of the barrier.
final
borderRadius → BorderRadius: Border radius for the cutout area.
final
clip → bool: Whether to clip a cutout area in the barrier.
final
hashCode → int: The hash code for this object.
no setterinherited
padding → EdgeInsets: Padding around the cutout area.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
semanticsBuilder → SemanticsBuilderCallback?: Returns a function that builds semantic information for the picture drawn by this painter.
no setterinherited

Methods

addListener(VoidCallback listener) → void: Register a closure to be notified when it is time to repaint.
inherited
hitTest(Offset position) → bool?: Called whenever a hit test is being performed on an object that is using this custom paint delegate.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
paint(Canvas canvas, Size size) → void: Called whenever the object needs to paint. The given Canvas has its coordinate space configured such that the origin is at the top left of the box. The area of the box is the size of the size argument.
override
removeListener(VoidCallback listener) → void: Remove a previously registered closure from the list of closures that the object notifies when it is time to repaint.
inherited
shouldRebuildSemantics(covariant CustomPainter oldDelegate) → bool: Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object, or any time that a new CustomPaint object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former).
inherited
shouldRepaint(covariant SurfaceBarrierPainter oldDelegate) → bool: Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object, or any time that a new CustomPaint object is created with a new instance of the custom painter delegate class (which amounts to the same thing, because the latter is implemented in terms of the former).
override
toString() → String: A string representation of this object.
inherited

Operators

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

Constants

bigOffset → const Offset: Large offset to center the big screen.
bigScreen → const Size: Large screen size for painting operations.
bigSize → const double: Large size constant for creating screen-filling effects.