LightSensor LightSensor LightSensor LightSensor LightSensor Class

Definition

public : sealed class LightSensor

struct winrt::Windows::Devices::Sensors::LightSensor

public sealed class LightSensor

Public NotInheritable Class LightSensor

// This class does not provide a public constructor.

Attributes

ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute StaticAttribute StaticAttribute ThreadingAttribute

Windows 10 requirements

Remarks

The following example demonstrates how a UWP app built with XAML and C# uses the GetDefault method to establish a connection to a light sensor. If no integrated light sensor is found, the method will return a null value.

_sensor = LightSensor.GetDefault();

The following example demonstrates how a UWP app built with XAML registers a ReadingChanged event handler.

private void ScenarioEnable(object sender, RoutedEventArgs e)
{
    if (_sensor != null)
    {
        // Establish the report interval
        _sensor.ReportInterval = _desiredReportInterval;

        Window.Current.VisibilityChanged += new WindowVisibilityChangedEventHandler(VisibilityChanged);
        _sensor.ReadingChanged += new TypedEventHandler<LightSensor, LightSensorReadingChangedEventArgs>(ReadingChanged);

        ScenarioEnableButton.IsEnabled = false;
        ScenarioDisableButton.IsEnabled = true;
    }
    else
    {
        rootPage.NotifyUser("No light sensor found", NotifyType.StatusMessage);
    }
}

The following example shows the ReadingChanged event handler.

async private void ReadingChanged(object sender, LightSensorReadingChangedEventArgs e)
{
    await Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
    {
        LightSensorReading reading = e.Reading;
        ScenarioOutput_LUX.Text = String.Format("{0,5:0.00}", reading.IlluminanceInLux);
    });
}

Version history

Properties

Methods

Events

See also

• LightSensor Sample
• Light sensor sample (Windows 10)