MagnetometerAccuracy enumeration

Specifies the accuracy of the magnetometer.

Syntax


typedef enum _MagnetometerAccuracy { 
  Unknown      = 0,
  Unreliable   = 1,
  Approximate  = 2,
  High         = 3
} MagnetometerAccuracy;

Constants

Unknown

The accuracy is currently not available, typically because the driver can't report it.

Unreliable

The reported values have a high degree of inaccuracy. Apps should always ask the user to calibrate the device whenever this value is returned.

Approximate

The actual and reported values differ but may be accurate enough for some applications. Apps that only need a relative value, like a virtual reality app, can continue without additional calibration.

High

The actual and reported values are accurate. No additional calibration is needed.

Remarks

Device drivers that support magnetometer accuracy should only report the Unreliable, Approximate, and High values.

Apps that need calibration may periodically ask the user to calibrate the device. We suggest doing this once every 10 minutes.

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

None supported

Version

Available in Windows 8.1.

Header

SensorsClassExtension.h

See also

Sensor Properties

 

 

Send comments about this topic to Microsoft

Show: