# CompassData

Source: https://www.nianticspatial.com/docs/api/swift/NSDK.NSDKFrameData.struct-CompassData/

CompassData

---

## Declaration

struct CompassData

## Summary

Compass and magnetometer data for heading information.
This structure contains orientation data from the device's compass,
providing heading information that can be used for location-based
AR experiences and waypoint navigation.

---

## Constructors

init(timestampMs: UInt64, headingAccuracy: Float, trueHeading: Float, base: ClockBase = .epoch)

#### Summary

Creates compass data with the specified parameters.

---

## Properties

| Name | Type | Summary |
| --- | --- | --- |
| var base | ClockBase | Clock that `timestampMs` is measured against. |
| var headingAccuracy | Float | Accuracy of the heading measurement (in degrees).Lower values indicate more accurate readings. Values above 15-20 degreesmay indicate poor compass calibration or magnetic interference. |
| var timestampMs | UInt64 | Timestamp when the compass reading was captured (in milliseconds),measured against the clock reported by `base`. |
| var trueHeading | Float | True heading relative to geographic north (in degrees).This value is corrected for magnetic declination and representsthe actual direction relative to true north (0-360 degrees). |

---

## Operators

| Name | Type | Summary |
| --- | --- | --- |
| static func != | Bool | Returns a Boolean value indicating whether two values are not equal.Inequality is the inverse of equality. For any values `a` and `b`, `a != b`implies that `a == b` is `false`.This is the default implementation of the not-equal-to operator (`!=`)for any type that conforms to `Equatable`. |

---

## Relationships

conforms to:  Swift.Equatable