docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRImageTrackingSubsystemDescriptor.Cinfo

    Construction information for the XRImageTrackingSubsystemDescriptor.

    Inherited Members
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    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

    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
    Boolean

    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
    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 can 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.

    Implements
    IEquatable<T>.Equals(T)

    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.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023