Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Compass

class in UnityEngine

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Interface into compass functionality.

Properties

enabledUsed to enable or disable compass. Note, that if you want Input.compass.trueHeading property to contain a valid value, you must also enable location updates by calling Input.location.Start().
headingAccuracyAccuracy of heading reading in degrees.
magneticHeadingThe heading in degrees relative to the magnetic North Pole. (Read Only)
rawVectorThe raw geomagnetic data measured in microteslas. (Read Only)
timestampTimestamp (in seconds since 1970) when the heading was last time updated. (Read Only)
trueHeadingThe heading in degrees relative to the geographic North Pole. (Read Only)

Did you find this page useful? Please give it a rating: