Options for drawing overlay content in a scene that aids in debugging the scene.
SDKs
- iOS 13.0+
- macOS 10.15+
- Mac Catalyst 13.0+
- Xcode 11.0+
Framework
- Reality
Kit
Declaration
struct ARView.DebugOptions
StructureARView
ARView
Topics
Configuring Debug Options
static let none: ARViewDisable all debugging overlays.
static let showDraw visualizations for collision objects and rigid bodies.
static let showEnable statistics collection and visualization.
static let showDisplay anchor origins.
static let showDisplay anchor geometry.
static let showDisplay a coordinate axis indicating the position and orientation of the AR world coordinate system.
static let showDisplay a point cloud showing intermediate results of the scene analysis used to track device position.
Creating a Debug Option Set
init()Creates an empty option set.
init<S>(S)Creates a new set from a finite sequence of items.
init(arrayCreates a set containing the elements of the given array literal.
Testing for Membership in a Debug Option Set
var isA Boolean value that indicates whether the set has no elements.
func contains(ARViewReturns a Boolean value that indicates whether a given element is a member of the option set.
Adding and Removing Options
func insert(ARViewAdds the given element to the option set if it is not already a member.
func update(with: ARViewInserts the given element into the set.
func remove(ARViewRemoves the given element and all elements subsumed by it.
func subtract(ARViewRemoves the elements of the given set from this set.
func subtracting(ARViewReturns a new set containing the elements of this set that do not occur in the given set.
Combining Options
func union(ARViewReturns a new option set of the elements contained in this set, in the given set, or in both.
func formInserts the elements of another set into this option set.
func intersection(ARViewReturns a new option set with only the elements contained in both this set and the given set.
func formRemoves all elements of this option set that are not also present in the given set.
func symmetricReturns a new option set with the elements contained in this set or in the given set, but not in both.
func formReplaces this set with a new set containing all elements contained in either this set or the given set, but not in both.
Comparing Options
func isReturns a Boolean value that indicates whether the set is a subset of another set.
func isReturns a Boolean value that indicates whether this set is a strict subset of the given set.
func isReturns a Boolean value that indicates whether the set is a superset of the given set.
func isReturns a Boolean value that indicates whether this set is a strict superset of the given set.
func isReturns a Boolean value that indicates whether the set has no members in common with the given set.
Relationships
Conforms To
See Also
Debugging the Session
var debugThe current debugging options.