Struct LightEstimationData

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

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

Namespace: UnityEngine.XR.ARFoundation

Syntax

public struct LightEstimationData : IEquatable<LightEstimationData>

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 { get; set; }

Property Value

Type	Description
System.Nullable<System.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 { get; set; }

Property Value

Type	Description
System.Nullable<System.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 { get; set; }

Property Value

Type	Description
System.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
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

Equals(LightEstimationData)

Declaration

public bool Equals(LightEstimationData other)

Parameters

Type	Name	Description
LightEstimationData	other

Returns

Type	Description
System.Boolean

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.ValueType.ToString()

Operators

Equality(LightEstimationData, LightEstimationData)

Declaration

public static bool operator ==(LightEstimationData lhs, LightEstimationData rhs)

Parameters

Type	Name	Description
LightEstimationData	lhs
LightEstimationData	rhs

Returns

Type	Description
System.Boolean

Inequality(LightEstimationData, LightEstimationData)

Declaration

public static bool operator !=(LightEstimationData lhs, LightEstimationData rhs)

Parameters

Type	Name	Description
LightEstimationData	lhs
LightEstimationData	rhs

Returns

Type	Description
System.Boolean