Class

ARDirectionalLightEstimate

Estimated environmental lighting information associated with a captured video frame in a face-tracking AR session.

Overview

When you run a face tracking AR session (see ARFaceTrackingConfiguration) with the isLightEstimationEnabled property set to true, ARKit uses the detected face as a light probe to estimate the directional lighting environment in the scene. The lightEstimate property of each frame vended by the session contains an ARDirectionalLightEstimate instance containing this information.

If you render your own overlay graphics for the AR scene, you can use this information in shading algorithms to help make those graphics match the real-world lighting conditions of the scene captured by the camera. (The ARSCNView class automatically uses this information to configure SceneKit lighting.)

Topics

Examining Light Parameters

var sphericalHarmonicsCoefficients: Data

Data describing the estimated lighting environment in all directions.

var primaryLightDirection: vector_float3

A vector indicating the orientation of the strongest directional light source in the scene.

var primaryLightIntensity: CGFloat

The estimated intensity, in lumens, of the strongest directional light source in the scene.

Relationships

Inherits From

See Also

Camera and Scene Details

class ARFrame

A video image and position tracking information captured as part of an AR session.

class ARCamera

Information about the camera position and imaging characteristics for a captured video frame in an AR session.

class ARLightEstimate

Estimated scene lighting information associated with a captured video frame in an AR session.