Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AugmentedReality > UARBlueprintLibrary > UARBlueprintLibrary::GetCurrentLightEstimate

Light Theme

Dark Theme

UARBlueprintLibrary::GetCurrentLightEstimate

An AugmentedReality session can be configured to provide light estimates.

Windows

MacOS

Linux

References

Module	AugmentedReality
Header	/Engine/Source/Runtime/AugmentedReality/Public/ARBlueprintLibrary.h
Include	#include "ARBlueprintLibrary.h"
Source	/Engine/Source/Runtime/AugmentedReality/Private/ARBlueprintLibrary.cpp

Syntax

static UARLightEstimate * GetCurrentLightEstimate()

Remarks

An AugmentedReality session can be configured to provide light estimates. The specific approach to light estimation can be configured by the [UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig)_ specified during StartARSession(). This function assumes that you will cast the returned `UARLightEstimate to a derived type corresponding to your session config.

Returns

a `UARLighEstimate_ that can be cast to a derived class.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss