One Logo Pool Ball
RealityKit · IOS API REFERENCE

ARView.Environment.SceneUnderstanding.Options

struct · iOS 13.4+ · SDK 27.1

struct Options

Available scene-understanding options.

Members (7)

get · iOS 13.4+

receivesLighting

TypeScript
get receivesLighting(): Promise<ARView_Environment_SceneUnderstanding_Options>
Swift declaration
static let receivesLighting: ARView.Environment.SceneUnderstanding.Options

The `.receivesLighting` option means that the virtual lights will interact with real world surfaces causing them to shine. The properties of the mesh will be set to a default material.

get · iOS 13.4+

default

TypeScript
get default(): Promise<ARView_Environment_SceneUnderstanding_Options>
Swift declaration
static let `default`: ARView.Environment.SceneUnderstanding.Options

The `.default` options is a sentinel value that indicates the user wants whatever scene-understanding features work with the current device and are supported. It overrides other options in the options set.

get · iOS 13.4+

physics

TypeScript
get physics(): Promise<ARView_Environment_SceneUnderstanding_Options>
Swift declaration
static let physics: ARView.Environment.SceneUnderstanding.Options

No abstract

init · iOS 13.4+

init

TypeScript
init(rawValue: number): Promise<ARView_Environment_SceneUnderstanding_Options>
Swift declaration
init(rawValue: UInt32)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 13.4+

rawValue

TypeScript
getRawValue($self: ARView_Environment_SceneUnderstanding_Options): Promise<number>
Swift declaration
let rawValue: UInt32

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

get · iOS 13.4+

collision

TypeScript
get collision(): Promise<ARView_Environment_SceneUnderstanding_Options>
Swift declaration
static let collision: ARView.Environment.SceneUnderstanding.Options

The `.collision` option means that the reconstructed geometry can be used for collision queries (i.e. raycasting)

get · iOS 13.4+

occlusion

TypeScript
get occlusion(): Promise<ARView_Environment_SceneUnderstanding_Options>
Swift declaration
static let occlusion: ARView.Environment.SceneUnderstanding.Options

The `.occlusion` option means that the reconstructed geometry will be used for rendering, but only to update the depth buffer. Parts of virtual objects which are behind the reconstructed geometry are not rendered.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityKit types →