Interface ICameraConfigApi | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Interface ICameraConfigApi

    This interface is typically implemented by platform-specific implementations of the XRCameraSubsystem to support CameraConfigurations. End users do not need to implement this. Use . to get a CameraConfigurationCollection.

    Namespace: UnityEngine.XR.ARExtensions
    Syntax
    public interface ICameraConfigApi

    Properties

    currentConfiguration

    Get or set the current CameraConfiguration. May throw if camera configurations are not supported, i.e., if GetConfiguration(Int32) returns zero, or if you attempt to set an unsupported configuration.

    Declaration
    CameraConfiguration currentConfiguration { get; set; }
    Property Value
    Type Description
    CameraConfiguration

    The currently active CameraConfiguration.

    Methods

    GetConfiguration(Int32)

    Get a specific CameraConfiguration.

    Declaration
    CameraConfiguration GetConfiguration(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The index of the configuration to retrieve. If index less than zero or greater than or equal to the number of supported configurations, this method should throw IndexOutOfRangeException.

    Returns
    Type Description
    CameraConfiguration

    The CameraConfiguration at index.

    GetConfigurationCount()

    Gets the number of supported CameraConfigurations.

    Declaration
    int GetConfigurationCount()
    Returns
    Type Description
    System.Int32

    The number of supported CameraConfigurations

    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