RealityKit · IOS API REFERENCE

ARView.Environment

struct · iOS 13.0+ · SDK 27.1

struct Environment

A description of background, lighting, and acoustic properties for a view’s content.

Members (8)

init · iOS 13.0+

init

TypeScript

static init(background: ARView_Environment_Background, lighting: ARView_Environment_ImageBasedLight, reverb: ARView_Environment_Reverb): Promise<ARView_Environment>

Swift declaration

init(background: ARView.Environment.Background, lighting: ARView.Environment.ImageBasedLight, reverb: ARView.Environment.Reverb)

Creates a new environment description with the given elements.

get · iOS 13.0+

background

TypeScript

get background(): Promise<ARView_Environment_Background>

Swift declaration

var background: ARView.Environment.Background

The background for the environment.

set · iOS 13.0+

background

TypeScript

setBackground(value: ARView_Environment_Background): Promise<void>

Swift declaration

var background: ARView.Environment.Background

The background for the environment.

set · iOS 13.4+

sceneUnderstanding

TypeScript

setSceneUnderstanding(value: ARView_Environment_SceneUnderstanding): Promise<void>

Swift declaration

var sceneUnderstanding: ARView.Environment.SceneUnderstanding { mutating get set }

The scene-understanding options for the view.

get · iOS 13.0+

reverb

TypeScript

get reverb(): Promise<ARView_Environment_Reverb>

Swift declaration

var reverb: ARView.Environment.Reverb

The amount of reverb in the scene.

set · iOS 13.0+

reverb

TypeScript

setReverb(value: ARView_Environment_Reverb): Promise<void>

Swift declaration

var reverb: ARView.Environment.Reverb

The amount of reverb in the scene.

get · iOS 13.0+

lighting

TypeScript

get lighting(): Promise<ARView_Environment_ImageBasedLight>

Swift declaration

var lighting: ARView.Environment.ImageBasedLight

The lighting used in the environment of a particular scene.

set · iOS 13.0+

lighting

TypeScript

setLighting(value: ARView_Environment_ImageBasedLight): Promise<void>

Swift declaration

var lighting: ARView.Environment.ImageBasedLight

The lighting used in the environment of a particular scene.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

ARView.Environment.sceneUnderstanding

The iOS SDK compiler rejected this binding: cannot use mutating getter on immutable value: 'o' is a 'let' constant

All RealityKit types →