docs.unity3d.com
    Show / Hide Table of Contents

    Struct ARLightEstimationData

    A structure for light estimation information provided by the AR device.

    Namespace: UnityEngine.XR.ARFoundation
    Syntax
    public struct ARLightEstimationData : IEquatable<ARLightEstimationData>

    Properties

    averageBrightness

    An estimate for the average brightness in the scene. Use averageBrightness.HasValue to determine if this information is available.

    Declaration
    public float? averageBrightness { readonly get; set; }
    Property Value
    Type Description
    Nullable<Single>
    Remarks

    averageBrightness may be null when light estimation is not enabled in the ARSession, if the platform does not support it, or if a platform-specific error has occurred.

    averageColorTemperature

    An estimate for the average color temperature of the scene. Use averageColorTemperature.HasValue to determine if this information is available.

    Declaration
    public float? averageColorTemperature { readonly get; set; }
    Property Value
    Type Description
    Nullable<Single>
    Remarks

    averageColorTemperature may be null when light estimation is not enabled in the ARSession, if the platform does not support it, or if a platform-specific error has occurred.

    colorCorrection

    The scaling factors used for color correction. The RGB scale factors are used to match the color of the light in the scene. The alpha channel value is platform-specific.

    Declaration
    public Color? colorCorrection { readonly get; set; }
    Property Value
    Type Description
    Nullable<Color>
    Remarks

    colorCorrection may be null when light estimation is not enabled in the ARSession, if the platform does not support it, or if a platform-specific error has occurred.

    Methods

    Equals(Object)

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

    Equals(ARLightEstimationData)

    Declaration
    public bool Equals(ARLightEstimationData other)
    Parameters
    Type Name Description
    ARLightEstimationData other
    Returns
    Type Description
    Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    Operators

    Equality(ARLightEstimationData, ARLightEstimationData)

    Declaration
    public static bool operator ==(ARLightEstimationData lhs, ARLightEstimationData rhs)
    Parameters
    Type Name Description
    ARLightEstimationData lhs
    ARLightEstimationData rhs
    Returns
    Type Description
    Boolean

    Inequality(ARLightEstimationData, ARLightEstimationData)

    Declaration
    public static bool operator !=(ARLightEstimationData lhs, ARLightEstimationData rhs)
    Parameters
    Type Name Description
    ARLightEstimationData lhs
    ARLightEstimationData rhs
    Returns
    Type Description
    Boolean
    In This Article
    • Properties
      • averageBrightness
      • averageColorTemperature
      • colorCorrection
    • Methods
      • Equals(Object)
      • Equals(ARLightEstimationData)
      • GetHashCode()
      • ToString()
    • Operators
      • Equality(ARLightEstimationData, ARLightEstimationData)
      • Inequality(ARLightEstimationData, ARLightEstimationData)
    Back to top
    Terms of use
    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