Declaration
compose().mask({
alignment?: SwiftUI.Alignment,
mask: ReactNode,
})nonisolated func mask<Mask>(
alignment: Alignment = .center,
@ContentBuilder _ mask: () -> Mask
) -> some View
where Mask : ViewParameters
options.alignmentSwiftUI.AlignmentThe alignment for
maskin relation to this view.options.mask*ReactNodeThe view whose alpha the rendering system applies to the specified view.
Discussion
Use mask(_:) when you want to apply the alpha (opacity) value of
another view to the current view.
This example shows an image masked by rectangle with a 10% opacity:
Image(systemName: "envelope.badge.fill")
.foregroundColor(Color.blue)
.font(.system(size: 128, weight: .regular))
.mask {
Rectangle().opacity(0.1)
}See also
More in Visual effects.
- allowedDynamicRangeReturns a new view configured with the specified allowed dynamic range.
- backgroundExtensionEffectAdds the background extension effect to the view. The view will be duplicated into mirrored copies which will be placed around the view on any edge with available safe area. Additionally, a blur effect will be applied on top to blur out the copies.
- blurApplies a Gaussian blur to this view.
- brightnessBrightens this view by the specified amount.
- clippedClips this view to its bounding rectangular frame.
- colorEffectReturns a new view that applies shader to self as a filter effect on the color of each pixel.
- colorInvertInverts the colors in this view.
- colorMultiplyAdds a color multiplication effect to this view.
- compositingGroupWraps this view in a compositing group.
- contrastSets the contrast and separation between similar colors in this view.
- distortionEffectReturns a new view that applies shader to self as a geometric distortion effect on the location of each pixel.
- drawingGroupComposites this view's contents into an offscreen image before final display.