Class XRImageTrackingSubsystemDescriptor

Describes the capabilities of an XRImageTrackingSubsystem.

Inheritance

object

SubsystemDescriptorWithProvider

SubsystemDescriptorWithProvider<XRImageTrackingSubsystem, XRImageTrackingSubsystem.Provider>

XRImageTrackingSubsystemDescriptor

Implements

ISubsystemDescriptor

Inherited Members

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

SubsystemDescriptorWithProvider.id

SubsystemDescriptorWithProvider.providerType

SubsystemDescriptorWithProvider.subsystemTypeOverride

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public class XRImageTrackingSubsystemDescriptor : SubsystemDescriptorWithProvider<XRImageTrackingSubsystem, XRImageTrackingSubsystem.Provider>, ISubsystemDescriptor

Properties

requiresPhysicalImageDimensions

True if the subsystem requires physical image dimensions to be provided for all reference images. If false, specifying the physical dimensions is optional.

Declaration

public bool requiresPhysicalImageDimensions { get; }

Property Value

Type	Description
bool

supportsImageValidation

Whether the subsystem supports image validation (validating images before they are added to a MutableRuntimeReferenceImageLibrary).

Declaration

public bool supportsImageValidation { get; }

Property Value

Type	Description
bool

supportsMovingImages

True if the subsystem supports tracking the poses of moving images in real time.

Declaration

public bool supportsMovingImages { get; }

Property Value

Type	Description
bool

supportsMutableLibrary

Whether the subsystem supports MutableRuntimeReferenceImageLibrary, a reference image library which can modified at runtime, as opposed to the XRReferenceImageLibrary, which is generated at edit time and cannot be modified at runtime.

Declaration

public bool supportsMutableLibrary { get; }

Property Value

Type	Description
bool

See Also

MutableRuntimeReferenceImageLibrary

CreateRuntimeLibrary(XRReferenceImageLibrary)

Methods

Create(Cinfo)

Registers a new descriptor with the SubsystemManager.

Declaration

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

Parameters

Type	Name	Description
XRImageTrackingSubsystemDescriptor.Cinfo	cinfo	The construction information for the new descriptor.

Register(Cinfo)

Registers a new descriptor with the SubsystemManager.

Declaration

public static void Register(XRImageTrackingSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRImageTrackingSubsystemDescriptor.Cinfo	cinfo	The construction information for the new descriptor.

Implements

ISubsystemDescriptor