Contents

SpotLight

An entity that illuminates virtual content in a cone-shaped volume.

Declaration

@MainActor @preconcurrency class SpotLight

Overview

During an AR session, RealityKit automatically lights your virtual objects to match real-world lighting. You can also explicitly add virtual lights that act upon your virtual content. This is typically most useful outside of an AR session on iOS or macOS, where your RealityViewCameraContent camera property is set to virtual.

A RealityKit scene can contain up to eight dynamic lights, which are entities that contain a SpotLightComponent, PointLightComponent, or a DirectionalLightComponent. This limit doesn’t include light from image-based lighting.

Topics

Creating a spotlight

See Also

Entity compliance