Class SpatialPlaneSubsystem
The OpenXR Spatial Entities implementation of the UnityEngine.XR.ARSubsystems.XRPlaneSubsystem. Don't create this directly. Use the SubsystemManager instead.
Inheritance
TrackingSubsystem<BoundedPlane, XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>
XRPlaneSubsystem
SpatialPlaneSubsystem
Implements
Inherited Members
XRPlaneSubsystem.requestedPlaneDetectionMode
XRPlaneSubsystem.currentPlaneDetectionMode
XRSubsystem<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.GetPermissionState()
SubsystemWithProvider<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.OnCreate()
SubsystemWithProvider<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.OnStart()
SubsystemWithProvider<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.OnStop()
SubsystemWithProvider<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.OnDestroy()
SubsystemWithProvider<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.subsystemDescriptor
SubsystemWithProvider<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.provider
SubsystemWithProvider.OnStart()
SubsystemWithProvider.OnStop()
SubsystemWithProvider.OnDestroy()
Namespace: UnityEngine.XR.OpenXR.Features.SpatialEntities
Assembly: Unity.XR.SpatialEntities.dll
Syntax
[Preserve]
public class SpatialPlaneSubsystem : XRPlaneSubsystem, ISubsystem
Methods
GetPermissionState()
Get the state of any required permissions for this subsystem to run on the current device.
Declaration
public override XRPermissionState GetPermissionState()
Returns
| Type | Description |
|---|---|
| XRPermissionState | The permission state. |
Overrides
UnityEngine.XR.ARSubsystems.XRSubsystem<UnityEngine.XR.ARSubsystems.XRPlaneSubsystem, UnityEngine.XR.ARSubsystems.XRPlaneSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRPlaneSubsystem.Provider>.GetPermissionState()
TryStartAsync(CancellationToken, XRSubsystemStartOptions)
Attempts to start the subsystem with the given options.
Declaration
public override Awaitable<XRResultStatus> TryStartAsync(CancellationToken token, XRSubsystemStartOptions options = XRSubsystemStartOptions.None)
Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | token | The cancellation token. |
| XRSubsystemStartOptions | options | The start options. |
Returns
| Type | Description |
|---|---|
| Awaitable<XRResultStatus> | A status representing whether the subsystem was successfully started, and any applicable error codes from the runtime. |