Struct ARLightEstimationData
A structure for light estimation information provided by the AR device.
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Syntax
public struct ARLightEstimationData : IEquatable<ARLightEstimationData>
Properties
ambientSphericalHarmonics
An estimation of the ambient scene lighting using spherical harmonics at the Level 2.
Declaration
public SphericalHarmonicsL2? ambientSphericalHarmonics { readonly get; set; }
Property Value
Type | Description |
---|---|
Nullable<UnityEngine.Rendering.SphericalHarmonicsL2> |
Remarks
ambientSphericalHarmonics can be null when light estimation is not enabled in the ARSession or a platform-specific error has occurred.
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 |
---|---|
Nullable<Single> |
Remarks
averageBrightness can be null when light estimation is not enabled in the ARSession, 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 can 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.
averageIntensityInLumens
An estimate for the average intensity, in lumens, in the scene.
Use averageIntensityInLumens.HasValue
to determine if this information is available.
Declaration
public float? averageIntensityInLumens { get; set; }
Property Value
Type | Description |
---|---|
Nullable<Single> |
Remarks
averageIntensityInLumens can be null when light estimation is not enabled in the ARSession, or if a platform-specific error has occurred.
averageMainLightBrightness
An estimate for the average brightness of the main light estimate in the scene.
Use averageMainLightBrightness.HasValue
to determine if this information is available.
Declaration
public float? averageMainLightBrightness { get; set; }
Property Value
Type | Description |
---|---|
Nullable<Single> |
Remarks
averageMainLightBrightness can be null when light estimation is not enabled in the ARSession, 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<UnityEngine.Color> |
Remarks
colorCorrection can 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.
mainLightColor
The estimated color of the main light.
Declaration
public Color? mainLightColor { readonly get; set; }
Property Value
Type | Description |
---|---|
Nullable<UnityEngine.Color> |
Remarks
mainLightColor can be null when light estimation is not enabled in the ARSession or a platform-specific error has occurred.
mainLightDirection
An estimate of where the main light of the scene is coming from.
Declaration
public Vector3? mainLightDirection { readonly get; set; }
Property Value
Type | Description |
---|---|
Nullable<UnityEngine.Vector3> |
Remarks
mainLightDirection can be null when light estimation is not enabled in the ARSession or a platform-specific error has occurred.
mainLightIntensityLumens
An estimate of the intensity of the main light in lumens.
Declaration
public float? mainLightIntensityLumens { readonly get; set; }
Property Value
Type | Description |
---|---|
Nullable<Single> |
Remarks
mainLightIntensityLumens can be null when light estimation is not enabled in the ARSession or a platform-specific error has occurred.
Methods
Equals(Object)
Compares for equality.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | An |
Returns
Type | Description |
---|---|
Boolean |
|
Overrides
Equals(ARLightEstimationData)
Compares for equality.
Declaration
public bool Equals(ARLightEstimationData other)
Parameters
Type | Name | Description |
---|---|---|
ARLightEstimationData | other | The other ARLightEstimationData to compare against. |
Returns
Type | Description |
---|---|
Boolean |
|
Implements
GetHashCode()
Generates a hash code suitable for use in HashSet
and Dictionary
.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 | A hash of the ARLightEstimationData. |
Overrides
ToString()
Generates a string representation of this ARLightEstimationData.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String | A string representation of this ARLightEstimationData. |
Overrides
Operators
Equality(ARLightEstimationData, ARLightEstimationData)
Compares lhs
and rhs
for equality using Equals(ARLightEstimationData).
Declaration
public static bool operator ==(ARLightEstimationData lhs, ARLightEstimationData rhs)
Parameters
Type | Name | Description |
---|---|---|
ARLightEstimationData | lhs | The left-hand-side ARLightEstimationData of the comparison. |
ARLightEstimationData | rhs | The right-hand-side ARLightEstimationData of the comparison. |
Returns
Type | Description |
---|---|
Boolean |
|
Inequality(ARLightEstimationData, ARLightEstimationData)
Compares lhs
and rhs
for inequality using Equals(ARLightEstimationData).
Declaration
public static bool operator !=(ARLightEstimationData lhs, ARLightEstimationData rhs)
Parameters
Type | Name | Description |
---|---|---|
ARLightEstimationData | lhs | The left-hand-side ARLightEstimationData of the comparison. |
ARLightEstimationData | rhs | The right-hand-side ARLightEstimationData of the comparison. |
Returns
Type | Description |
---|---|
Boolean |
|