docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class RoomPlanBoundingBoxSubsystem

    The implementation of the XRBoundingBoxSubsystem. Do not create this directly. Use the SubsystemManager instead.

    Inheritance
    object
    SubsystemWithProvider
    SubsystemWithProvider<XRBoundingBoxSubsystem, XRBoundingBoxSubsystemDescriptor, XRBoundingBoxSubsystem.Provider>
    XRSubsystem<XRBoundingBoxSubsystem, XRBoundingBoxSubsystemDescriptor, XRBoundingBoxSubsystem.Provider>
    TrackingSubsystem<XRBoundingBox, XRBoundingBoxSubsystem, XRBoundingBoxSubsystemDescriptor, XRBoundingBoxSubsystem.Provider>
    XRBoundingBoxSubsystem
    RoomPlanBoundingBoxSubsystem
    Implements
    ISubsystem
    Inherited Members
    XRBoundingBoxSubsystem.GetChanges(Allocator)
    TrackingSubsystem<XRBoundingBox, XRBoundingBoxSubsystem, XRBoundingBoxSubsystemDescriptor, XRBoundingBoxSubsystem.Provider>.GetChanges(Allocator)
    XRSubsystem<XRBoundingBoxSubsystem, XRBoundingBoxSubsystemDescriptor, XRBoundingBoxSubsystem.Provider>.GetPermissionState()
    XRSubsystem<XRBoundingBoxSubsystem, XRBoundingBoxSubsystemDescriptor, XRBoundingBoxSubsystem.Provider>.TryStartAsync(CancellationToken, XRSubsystemStartOptions)
    SubsystemWithProvider<XRBoundingBoxSubsystem, XRBoundingBoxSubsystemDescriptor, XRBoundingBoxSubsystem.Provider>.subsystemDescriptor
    SubsystemWithProvider.Start()
    SubsystemWithProvider.Stop()
    SubsystemWithProvider.Destroy()
    SubsystemWithProvider.running
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.XR.ARKit
    Assembly: Unity.XR.ARKit.dll
    Syntax
    [Preserve]
    public sealed class RoomPlanBoundingBoxSubsystem : XRBoundingBoxSubsystem, ISubsystem

    Methods

    GetRoomCaptureInstruction(out XRBoundingBoxInstructions)

    Receive the instruction during room capture.

    Declaration
    public void GetRoomCaptureInstruction(out XRBoundingBoxInstructions instruction)
    Parameters
    Type Name Description
    XRBoundingBoxInstructions instruction

    The instruction from room capture process.

    Examples

    IsRoomCapturing()

    Check the status of room capture process.

    Declaration
    public bool IsRoomCapturing()
    Returns
    Type Description
    bool

    True if the process is room capturing, otherwise false.

    Examples

    SetupRoomCapture()

    Set up room capture.

    Declaration
    public bool SetupRoomCapture()
    Returns
    Type Description
    bool

    True if room capture is successfully set up, otherwise false.

    Examples

    StartRoomCapture()

    Start the room capture process.

    Declaration
    public void StartRoomCapture()
    Examples

    StopRoomCapture()

    Stop the room capture process.

    Declaration
    public void StopRoomCapture()
    Examples

    Implements

    ISubsystem
    In This Article
    Back to top
    Copyright © 2026 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)