TechnologiesAR & Spatial

SpatialPreview

iOSmacOStvOSwatchOSvisionOS

SpatialPreview enables spatial preview sessions that present 3D content and documents from your Mac to connected visionOS devices through Mac Virtual Display. You conform to the SpatialPreviewSession protocol or use the concrete USDPreviewSession and DocumentPreviewSession classes to drive a session, identifying its target with a SpatialPreviewEndpoint. Track the session through SpatialPreviewSessionState and handle failures reported as SpatialPreviewSessionError. The framework is available on macOS.

Essentials 1

Drive a spatial preview session by adopting the session protocol.

  • Pr
    SpatialPreviewSessionmacOS 27.0+
    A session that manages the lifecycle and connection state of a spatial preview on a visionOS device.

Preview Sessions 2

Concrete session types that present 3D content and documents to a connected visionOS device.

  • Cl
    USDPreviewSessionmacOS 27.0+
    A session that presents USD-based 3D content to a connected visionOS device through Mac Virtual Display.
  • Cl
    DocumentPreviewSessionmacOS 27.0+
    Document session allows you to present the contents of a URL or Data.

Session Targets 1

Identify the destination for a spatial preview session.

  • St
    SpatialPreviewEndpointmacOS 27.0+
    An endpoint representing a destination that that can be connected to

Session State and Errors 2

Track a session's progress and handle failures it reports.

  • En
    SpatialPreviewSessionStatemacOS 27.0+
    Indicates the state of the session and the health of the underlying connection.
  • En
    SpatialPreviewSessionErrormacOS 27.0+
    Constants that describe failures that can occur during a spatial preview session.

Classes 1

  • Cl
    ConnectedSpatialEndpointObservermacOS 27.0+

Structures 1

  • St
    SpatialPreviewDevicePicker
    Presents nearby companion devices and allows the user to make a selection.
← AR & Spatial