Struct XRImageTrackingSubsystemDescriptor.Cinfo

Construction information for the XRImageTrackingSubsystemDescriptor.

Implements
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
public struct XRImageTrackingSubsystemDescriptor.Cinfo : IEquatable<XRImageTrackingSubsystemDescriptor.Cinfo>

Properties

id

A string identifier used to name the subsystem provider.

Declaration
public string id { readonly get; set; }
Property Value
Type Description
string

providerType

Specifies the provider implementation type to use for instantiation.

Declaration
public Type providerType { readonly get; set; }
Property Value
Type Description
Type

The provider implementation type to use for instantiation.

requiresPhysicalImageDimensions

Whether 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 { readonly get; set; }
Property Value
Type Description
bool

subsystemImplementationType

The System.Type of the provider implementation, used to instantiate the class.

Declaration
[Obsolete("XRImageTrackingSubsystem no longer supports the deprecated set of base classes for subsystems as of Unity 2020.2. Use providerType and, optionally, subsystemTypeOverride instead.", true)]
public Type subsystemImplementationType { readonly get; set; }
Property Value
Type Description
Type

subsystemTypeOverride

Specifies the XRImageTrackingSubsystem-derived type that forwards casted calls to its provider.

Declaration
public Type subsystemTypeOverride { readonly get; set; }
Property Value
Type Description
Type

The type of the subsystem to use for instantiation. If null, XRImageTrackingSubsystem will be instantiated.

supportsImageValidation

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

Declaration
public bool supportsImageValidation { readonly get; set; }
Property Value
Type Description
bool

supportsMovingImages

Whether the subsystem supports tracking the poses of moving images in realtime.

Declaration
public bool supportsMovingImages { readonly get; set; }
Property Value
Type Description
bool
Remarks

If true, currentMaxNumberOfMovingImages and requestedMaxNumberOfMovingImages should be implemented.

supportsMutableLibrary

Whether the subsystem supports image libraries that can be mutated at runtime.

Declaration
public bool supportsMutableLibrary { readonly get; set; }
Property Value
Type Description
bool
Remarks

If true, CreateRuntimeLibrary(XRReferenceImageLibrary) must be implemented and imageLibrary will never be called.

See Also

Methods

Equals(object)

Tests for equality.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj

The object to compare against.
Returns
Type Description
bool

True if obj is of type XRImageTrackingSubsystemDescriptor.Cinfo and Equals(Cinfo) also returns true; otherwise false.
Overrides

Equals(Cinfo)

Tests for equality.

Declaration
public bool Equals(XRImageTrackingSubsystemDescriptor.Cinfo other)
Parameters
Type Name Description
XRImageTrackingSubsystemDescriptor.Cinfo other

The other XRImageTrackingSubsystemDescriptor.Cinfo to compare against.
Returns
Type Description
bool

True if every field in other is equal to this XRImageTrackingSubsystemDescriptor.Cinfo, otherwise false.

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code generated from this object's fields.
Overrides

Operators

operator ==(Cinfo, Cinfo)

Tests for equality. Same as Equals(Cinfo).

Declaration
public static bool operator ==(XRImageTrackingSubsystemDescriptor.Cinfo lhs, XRImageTrackingSubsystemDescriptor.Cinfo rhs)
Parameters
Type Name Description
XRImageTrackingSubsystemDescriptor.Cinfo lhs

The left-hand side of the comparison.
XRImageTrackingSubsystemDescriptor.Cinfo rhs

The right-hand side of the comparison.
Returns
Type Description
bool

True if lhs is equal to rhs, otherwise false.

operator !=(Cinfo, Cinfo)

Tests for inequality. Same as !Equals(Cinfo).

Declaration
public static bool operator !=(XRImageTrackingSubsystemDescriptor.Cinfo lhs, XRImageTrackingSubsystemDescriptor.Cinfo rhs)
Parameters
Type Name Description
XRImageTrackingSubsystemDescriptor.Cinfo lhs

The left-hand side of the comparison.
XRImageTrackingSubsystemDescriptor.Cinfo rhs

The right-hand side of the comparison.
Returns
Type Description
bool

True if lhs is not equal to rhs, otherwise false.

Implements