breakthroughEffect(_:)

Declaration

nonisolated func breakthroughEffect(_ effect: BreakthroughEffect) -> some View

Parameters

• effect:

  The type of effect to apply when the view is occluded by other content.

Discussion

Breakthrough is an effect allowing elements to be visible to the user even when other app content (3D models, UI elements) is positioned in front. The way the element breaks through content in front depends on the chosen BreakthroughEffect.

This modifier can be used in a number of scenarios, including ornaments and RealityView attachments to have them break through in their entirety.

Regular Elements

To have SwiftUI element break through content in front, apply the breakthroughEffect modifier directly to the View:

ResizeHandle()
    .breakthroughEffect(.subtle)

Ornaments

When applied to the whole content of an ornament, the ornament (including its background) will break through content in front:

Text("A view with an ornament")
    .ornament(attachmentAnchor: .scene(.bottom)) {
        OrnamentContent()
            .glassBackgroundEffect()
            .breakthroughEffect(.prominent)
    }

RealityView Attachments

Similarly, a RealityView Attachment can break through other entities in the RealityView, including the entity it is attached to:

Attachment(id: "example") {
    AttachmentContent()
        .breakthroughEffect(.subtle)
}

Presentations

Most system presentations appear with a breakthrough effect by default. For these cases, you can customize the type of effect by applying the presentationBreakthroughEffect(_:) modifier to the content of the presentation, like in the following example:

Button("Show Details") {
    isShowingDetails = true
}
.popover(isPresented: $isShowingDetails) {
    DetailsView()
        .presentationBreakthroughEffect(.prominent)
}

This also applies to RealityKit presentations using RealityKit/PresentationComponent