Contents

RoomCaptureView

A view that enables the user to scan their room with the device’s camera.

Declaration

@MainActor @objc @preconcurrency class RoomCaptureView

Mentioned in

Overview

This class provides your app with a view that manages the scan process from start to finish, including:

  • A camera feed that users look through to see their room in AR.

  • Real-time graphic overlays that display on top of physical structures in the room to convey scanning progress.

  • User instructions that explain how to position the device, if the framework requires a specific kind of device movement or perspective to complete the capture.

When the app determines that the current scan is complete, the view displays a small-scale version of the scanned room for the user to approve.

Alternatively, your app can display custom graphics during the scanning process by creating and using a scan session object (RoomCaptureSession) directly.

See Create a 3D model of an interior room by guiding the user through an AR experience for a sample code project that demonstrates RoomCaptureView.

Topics

Creating a room-capture view

Reacting to scan events

Displaying scan progress

Accessing view features

See Also

User Interface