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 > Plugins > MagicLeapLightEstimation > IMagicLeapLightEstimationPlugin > IMagicLeapLightEstimationPlugin::GetAmbientGlobalState

Light Theme

Dark Theme

IMagicLeapLightEstimationPlugin::GetAmbientGlobalState

Gets information about the ambient light sensor global state.

Windows

MacOS

Linux

References

Module	MagicLeapLightEstimation
Header	/Engine/Plugins/Lumin/MagicLeapLightEstimation/Source/MagicLeapLightEstimation/Public/IMagicLeapLightEstimationPlugin.h
Include	#include "IMagicLeapLightEstimationPlugin.h"

Syntax

bool GetAmbientGlobalState
(
FMagicLeapLightEstimationAmbientGlobalState & GlobalAmbientState
) const

Remarks

Gets information about the ambient light sensor global state. @note Capturing images or video will stop the lighting information update, causing the retrieved data to be stale (old timestamps).

Returns

true if the global ambient state was succesfully retrieved.

Parameters

Parameter	Description
GlobalAmbientState	Output param containing the information about the global lighting state (ambient intensity). Valid only if return value of function is true.

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

Take our survey

Dismiss