C API Unity API
Unity API Reference
IlluminationData Class Reference

Provides realtime data of real-world illumination calculations by ARKit, when used by Vuforia Fusion More...

Public Attributes

float AmbientColorTemperature => mIlluminationInfo.AmbientColorTemperature
 The current color temperature for the scene measured in Kelvin. The value may not be available on all platforms. When the value is unavailable NULL will be returned. More...
 
float AmbientIntensity => mIlluminationInfo.AmbientIntensity
 The current ambient intensity for the scene measured in Lumens. The value may not be available on all platforms. When the value is unavailable NULL will be returned. More...
 
Vector4 ColorCorrection => mIlluminationInfo.ColorCorrection
 
float IntensityCorrection => mIlluminationInfo.IntensityCorrection
 Returns a floating point intensity value which can be applied to a shader when rendering the color for an augmentation to reflect the ambient light in the scene. More...
 

Detailed Description

Provides realtime data of real-world illumination calculations by ARKit, when used by Vuforia Fusion

Member Data Documentation

float AmbientColorTemperature => mIlluminationInfo.AmbientColorTemperature

The current color temperature for the scene measured in Kelvin. The value may not be available on all platforms. When the value is unavailable NULL will be returned.

This value will be valid when ARKit is being used by Vuforia Fusion.

float AmbientIntensity => mIlluminationInfo.AmbientIntensity

The current ambient intensity for the scene measured in Lumens. The value may not be available on all platforms. When the value is unavailable NULL will be returned.

This value will be valid when ARKit is being used by Vuforia Fusion.

Vector4 ColorCorrection => mIlluminationInfo.ColorCorrection

Returns
a Vec4F which contains RGBA color correction values which can be applied to a shader when rendering the color for an augmentation to reflect the ambient light in the scene.

Color correction usage is described here, https://library.vuforia.com/content/vuforia-library/en/articles/Solution/using-vuforia-fusion-illumination.html

All values are reported in gamma space where gamma is 2.2. When used in a gamma space component wise multiply the values with the final calculated color.

In a linear color space convert to linear using pow(colorCorrection[i], 2.2) and then component wise multiply the values with the final calculated color component.

The values will always be valid for use. 1.0 is used in cases where the platform does not supply values.

This value will differ from the default when ARCore is being used by Vuforia Fusion.

float IntensityCorrection => mIlluminationInfo.IntensityCorrection

Returns a floating point intensity value which can be applied to a shader when rendering the color for an augmentation to reflect the ambient light in the scene.

Intensity correction usage is described here, https://library.vuforia.com/content/vuforia-library/en/articles/Solution/using-vuforia-fusion-illumination.html

Intensity correction is a value that can be applied directly to a shader. Values are in the range (0.0, 1.0), zero is black and 1.0 is white.

If rendering in gamma space divide by 0.466 (middle grey in gamma) and multiply by the final rendered color.

In a linear space use pow(intensityCorrection, 2.2)/0.18 pow(intensityCorrection, 2.2) converts to linear space and then the value is normalized by dividing by 0.18 middle grey in linear space.

The value will always be valid for use. 0.466 (middle grey) is used in cases where the platform does not supply a value.