immersiveEnvironmentBehavior(_:)

Declaration

nonisolated func immersiveEnvironmentBehavior(_ behavior: ImmersiveEnvironmentBehavior) -> some Scene

Parameters

• behavior:

  A immersive environment behavior that should be applied by the system when this scene opens.

Return Value

A scene that uses the specified behavior.

Discussion

Use this modifier to control how the immersive environment behaves when an ImmersiveSpace is opened, that uses an immersion style that supports keeping the immersive environment visible.

For example, the following app defines an Immersive Space that displays an interactive car engine model, and by setting the system environment behavior to .coexist, the immersive environment can remain shown while inspecting the details of the engine:

@main
struct App: App {
    var body: some Scene {
        ImmersiveSpace {
            CarEngineModel()
        }
        .immersiveEnvironmentBehavior(.coexist)
    }
}

Note: The behavior is a preference and does not always have to be honored by the system.