Struct ARLightEstimationData
A structure for light estimation information provided by the AR device.
Implements
Inherited Members
Namespace: UnityEngine .XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
public struct ARLightEstimationData : IEquatable<ARLightEstimationData>
Remarks
While you can request any of these simultaneously, support for each varies among devices. Some platforms might not be able to simultaneously provide all options, or it might depend on other features (for example, camera Facing Direction).
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 |
---|---|
Spherical |
Remarks
ambient
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 |
---|---|
float? |
Remarks
average
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 |
---|---|
float? |
Remarks
average
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 |
---|---|
float? |
Remarks
average
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 |
---|---|
float? |
Remarks
average
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 |
---|---|
Color? |
Remarks
color
mainLightColor
The estimated color of the main light.
Declaration
public Color? mainLightColor { readonly get; set; }
Property Value
Type | Description |
---|---|
Color? |
Remarks
main
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 |
---|---|
Vector3? |
Remarks
main
mainLightIntensityLumens
An estimate of the intensity of the main light in lumens.
Declaration
public float? mainLightIntensityLumens { readonly get; set; }
Property Value
Type | Description |
---|---|
float? |
Remarks
main
Methods
Equals(object)
Compares for equality.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | An |
Returns
Type | Description |
---|---|
bool |
|
Overrides
Equals(ARLightEstimationData)
Compares for equality.
Declaration
public bool Equals(ARLightEstimationData other)
Parameters
Type | Name | Description |
---|---|---|
ARLight |
other | The other ARLight |
Returns
Type | Description |
---|---|
bool |
|
GetHashCode()
Generates a hash code suitable for use in HashSet
and Dictionary
.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | A hash of the ARLight |
Overrides
ToString()
Generates a string representation of this ARLight
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string | A string representation of this ARLight |
Overrides
Operators
operator ==(ARLightEstimationData, ARLightEstimationData)
Compares lhs
and rhs
for equality using Equals(ARLight
Declaration
public static bool operator ==(ARLightEstimationData lhs, ARLightEstimationData rhs)
Parameters
Type | Name | Description |
---|---|---|
ARLight |
lhs | The left-hand-side ARLight |
ARLight |
rhs | The right-hand-side ARLight |
Returns
Type | Description |
---|---|
bool |
|
operator !=(ARLightEstimationData, ARLightEstimationData)
Compares lhs
and rhs
for inequality using Equals(ARLight
Declaration
public static bool operator !=(ARLightEstimationData lhs, ARLightEstimationData rhs)
Parameters
Type | Name | Description |
---|---|---|
ARLight |
lhs | The left-hand-side ARLight |
ARLight |
rhs | The right-hand-side ARLight |
Returns
Type | Description |
---|---|
bool |
|