CompassReading Class

  • Reference

Definition

Namespace:
Windows.Devices.Sensors
Edit

Represents a compass reading.

public ref class CompassReading sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CompassReading final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CompassReading
Public NotInheritable Class CompassReading
Inheritance
Object Platform::Object IInspectable CompassReading
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

This object is accessed when you invoke the GetCurrentReading method; and, it is accessed when you retrieve the Reading property of the CompassReadingChangedEventArgs object in the event callback method.

Version history

Windows version SDK version Value added
1709 16299 PerformanceCount
1709 16299 Properties

Properties

HeadingAccuracy

Gets the compass's heading accuracy.
HeadingMagneticNorth

Gets the heading in degrees relative to magnetic-north.
HeadingTrueNorth

Gets the heading in degrees relative to geographic true-north.
PerformanceCount

Gets the performance count associated with the reading. This allows the reading to be synchronized with other devices and processes on the system.
Properties

Gets the data properties reported by the sensor.
Timestamp

Gets the time at which the sensor reported the reading.

Applies to

See also