Struct CameraConfigurationCollection.ConfigEnumerator | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Struct CameraConfigurationCollection.ConfigEnumerator

    A custom enumerator for CameraConfigurations.

    Inherited Members
    System.ValueType.Equals(System.Object)
    System.ValueType.GetHashCode()
    System.ValueType.ToString()
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    Namespace: UnityEngine.XR.ARExtensions
    Syntax
    public struct ConfigEnumerator : IEnumerator, IEnumerator<CameraConfiguration>

    Constructors

    ConfigEnumerator(ICameraConfigApi)

    Constructs an enumerator from an XRCameraSubsystem

    Declaration
    public ConfigEnumerator(ICameraConfigApi api)
    Parameters
    Type Name Description
    ICameraConfigApi api

    The ICameraConfigApi required to enumerate the supported configurations.

    Properties

    Current

    Get the current CameraConfiguration. Throws if there are no more configurations, i.e., if MoveNext() has returned false.

    Declaration
    public CameraConfiguration Current { get; }
    Property Value
    Type Description
    CameraConfiguration

    Methods

    Dispose()

    Dispose the enumerator. Provided for compatibility with IEnumerator.

    Declaration
    public void Dispose()

    MoveNext()

    Move to the next supported configuration.

    Declaration
    public bool MoveNext()
    Returns
    Type Description
    System.Boolean

    true if there are more configurations, false otherwise.

    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