Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Compass

Interface into compass functionality.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Class
  • Namespace: UnityEngine
  • Assembly: UnityEngine.InputLegacyModule
public class Compass

Properties

Property

Description

enabledUse 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. To do this, call 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)
timestampIndicates the time elapsed since the compass heading was last updated. (Read Only)
trueHeadingThe heading in degrees relative to the geographic North Pole. (Read Only)