Class XRSessionSubsystemDescriptor

Descriptor for the XRSessionSubsystem describing capabilities which may vary by implementation.

Inheritance

object

SubsystemDescriptorWithProvider

SubsystemDescriptorWithProvider<XRSessionSubsystem, XRSessionSubsystem.Provider>

XRSessionSubsystemDescriptor

Implements

ISubsystemDescriptor

Inherited Members

SubsystemDescriptorWithProvider<XRSessionSubsystem, XRSessionSubsystem.Provider>.Create()

SubsystemDescriptorWithProvider.id

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public sealed class XRSessionSubsystemDescriptor : SubsystemDescriptorWithProvider<XRSessionSubsystem, XRSessionSubsystem.Provider>, ISubsystemDescriptor

Properties

supportsInstall

Whether the session supports the update or installation of session software.

Declaration

[Obsolete("supportsInstall has been deprecated in AR Foundation version 6.7. Pass XRSubsystemStartOptions.InstallSoftwareIfNeeded to TryStartAsync to install required software instead.")]
public bool supportsInstall { get; }

Property Value

Type	Description
bool

Remarks

Pass InstallSoftwareIfNeeded to XRSubsystem.TryStartAsync to install required software instead.

supportsMatchFrameRate

Whether the session supports matching the AR frame rate to the Unity frame rate.

Declaration

public bool supportsMatchFrameRate { get; }

Property Value

Type	Description
bool

Methods

Register(Cinfo)

Register a subsystem implementation. This should only be used by subsystem implementors.

Declaration

public static void Register(XRSessionSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRSessionSubsystemDescriptor.Cinfo	cinfo	Information used to construct the descriptor.

RegisterDescriptor(Cinfo)

Register a subsystem implementation. This should only be used by subsystem implementors.

Declaration

[Obsolete("RegisterDescriptor(Cinfo) has been deprecated in AR Foundation version 6.0. Use Register(Cinfo) instead (UnityUpgradable) -> Register(*)", false)]
public static void RegisterDescriptor(XRSessionSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRSessionSubsystemDescriptor.Cinfo	cinfo	Information used to construct the descriptor.

Implements

ISubsystemDescriptor