Struct XRImageTrackingSubsystemDescriptor.Cinfo

Construction information for the XRImageTrackingSubsystemDescriptor.

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct 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

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
Boolean

subsystemImplementationType

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

Declaration

public Type subsystemImplementationType { readonly get; set; }

Property Value

Type	Description
Type

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
Boolean

supportsMovingImages

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

Declaration

public bool supportsMovingImages { readonly get; set; }

Property Value

Type	Description
Boolean

Remarks

If true, currentMaxNumberOfMovingImages and requestedMaxNumberOfMovingImages should be implemented.

supportsMutableLibrary

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

Declaration

public bool supportsMutableLibrary { readonly get; set; }

Property Value

Type	Description
Boolean

Remarks

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

See Also

MutableRuntimeReferenceImageLibrary

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
Boolean	True if obj is of type XRImageTrackingSubsystemDescriptor.Cinfo and Equals(XRImageTrackingSubsystemDescriptor.Cinfo) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

Equals(XRImageTrackingSubsystemDescriptor.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
Boolean	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
Int32	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

Operators

Equality(XRImageTrackingSubsystemDescriptor.Cinfo, XRImageTrackingSubsystemDescriptor.Cinfo)

Tests for equality. Same as Equals(XRImageTrackingSubsystemDescriptor.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
Boolean	True if lhs is equal to rhs, otherwise false.

Inequality(XRImageTrackingSubsystemDescriptor.Cinfo, XRImageTrackingSubsystemDescriptor.Cinfo)

Tests for inequality. Same as !Equals(XRImageTrackingSubsystemDescriptor.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
Boolean	True if lhs is not equal to rhs, otherwise false.