Stay organized with collections
Save and categorize content based on your preferences.
GARGeospatialMode
Summary
Enumerations
GARGeospatialMode
GARGeospatialMode
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-14 UTC.
[null,null,["Last updated 2025-07-14 UTC."],[[["\u003cp\u003e\u003ccode\u003eGARGeospatialMode\u003c/code\u003e controls the behavior of ARCore Geospatial API features.\u003c/p\u003e\n"],["\u003cp\u003eIt includes two modes: \u003ccode\u003eGARGeospatialModeDisabled\u003c/code\u003e (default) and \u003ccode\u003eGARGeospatialModeEnabled\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGARGeospatialModeEnabled\u003c/code\u003e allows access to Earth state and geospatial anchors, requiring location permissions and device compatibility.\u003c/p\u003e\n"],["\u003cp\u003eDevice compatibility for Geospatial modes can be checked using \u003ccode\u003eisGeospatialModeSupported:\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# GARGeospatialMode\n=================\n\nSummary\n-------\n\n| ### Enumerations ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|\n| [GARGeospatialMode](#gargeospatialmode)`{` ` `[GARGeospatialModeDisabled](#gargeospatialmodedisabled)` = 0,` ` `[GARGeospatialModeEnabled](#gargeospatialmodeenabled)` = 1` `}` | enum Describes the desired behavior of ARCore Geospatial API features and capabilities. |\n\nEnumerations\n------------\n\n### GARGeospatialMode\n\n```text\n GARGeospatialMode\n``` \nDescribes the desired behavior of ARCore Geospatial API features and capabilities.\n\nNot all devices support all modes. Use [isGeospatialModeSupported: (GARSession(Geospatial))](/ar/reference/ios/category/GARSession(Geospatial)#isgeospatialmodesupported:) to find whether the current device supports a particular Geospatial mode. The default value is [GARGeospatialModeDisabled](/ar/reference/ios/group/GARGeospatialMode#gargeospatialmodedisabled).\n\n| Properties ||\n|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| GARGeospatialModeDisabled | The Geospatial API is disabled. |\n| GARGeospatialModeEnabled | The Geospatial API is enabled. [GARFrame.earth](/ar/reference/ios/category/GARFrame(Geospatial)#earth) will return valid [GAREarth](/ar/reference/ios/interface/GAREarth#interface_g_a_r_earth) instances, and [createAnchorWithCoordinate:altitude:eastUpSouthQAnchor:error: (GARSession(Geospatial))](/ar/reference/ios/category/GARSession(Geospatial)#createanchorwithcoordinate:altitude:eastupsouthqanchor:error:) will be enabled. Configuring the session with this mode may result in the following error codes: - [GARSessionErrorCodeLocationPermissionNotGranted](/ar/reference/ios/group/GARSessionErrorCode#garsessionerrorcodelocationpermissionnotgranted) - Geospatial mode requires location permission (at least when-in-use) with full accuracy. - [GARSessionErrorCodeConfigurationNotSupported](/ar/reference/ios/group/GARSessionErrorCode#garsessionerrorcodeconfigurationnotsupported) - Geospatial mode not supported on this device or OS version. Use [isGeospatialModeSupported: (GARSession(Geospatial))](/ar/reference/ios/category/GARSession(Geospatial)#isgeospatialmodesupported:) to determine this before attempting to configure the session. \u003cbr /\u003e |"]]
